Skip to main content
GET
/
v1
/
collaborators
Get collaborators
curl --request GET \
  --url https://api.capitalcheckin.app/v1/collaborators \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "[email protected]",
      "phone": "<string>",
      "position": "<string>",
      "department": "<string>",
      "status": "active",
      "role": "admin",
      "hire_date": "2023-12-25",
      "salary": 123,
      "manager_id": "<string>",
      "work_schedule": "<string>",
      "location": "<string>",
      "avatar_url": "<string>",
      "emergency_contact": {
        "name": "<string>",
        "phone": "<string>",
        "relationship": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "has_next": true,
    "has_prev": true
  }
}

Authorizations

Authorization
string
header
required

OAuth2 access token for authentication

Query Parameters

page
integer
default:1

Page number

per_page
integer
default:10

Items per page

Required range: x <= 100
status
enum<string>

Filter by status

Available options:
active,
inactive,
pending
department
string

Filter by department

Search in name, email, or position

Response

Collaborators list

data
object[]

List of collaborators

meta
object