Get Started

Workspace Members

API endpoint for managing workspace members. Supports retrieving members with optional filtering, sorting, and pagination, as well as inviting, removing, and updating member roles.

GETPOSTPATCHDELETE
GET/workspace/members

Headers

x-api-keystringrequired

Your Track My Posts API key

Query Parameters

workspaceSlugstringrequired

Workspace slug identifier

Example: my-workspace

pageinteger

Page number (1-indexed)

Example: 1

limitinteger

Number of items per page (max 100)

Example: 20

sortBystring

Field to sort by

Example: name

sortOrderstring

Sort order

Example: asc

querystring

Search query to filter members by name or email

Example: john

Responses

200Successful response with paginated members
400Bad request - validation error
401Unauthorized - authentication required
403Forbidden - insufficient permissions
404Not found - workspace not found
500Internal server error
curl "https://api.trackmyposts.com/workspace/members?workspaceSlug=my-workspace&page=1&limit=20&sortBy=name&sortOrder=asc&query=john" \
  -H "x-api-key: YOUR_API_KEY"
{
  "items": [
    {
      "id": "member-123",
      "role": "admin",
      "status": "active",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "user": {
        "id": "user-456",
        "email": "john@example.com",
        "fullName": "John Doe",
        "avatarUrl": "https://example.com/avatar.png",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 15,
  "totalPages": 1,
  "hasNext": false,
  "hasPrev": false
}

Data Structures

View all 10 data structuresWorkspace Members

Explore all data structures used in this API endpoint