Pagination

List endpoints return paginated results using limit and offset parameters.

Parameters

Parameter	Type	Default	Description
`limit`	integer	10	Number of items per page
`offset`	integer	0	Starting position in the result set

Example

To fetch users in pages of 10:

# First page (items 1-10)
curl --request GET \
  --url 'https://api.connecteam.com/users/v1/users?limit=10&offset=0' \
  --header 'X-API-KEY: YOUR_API_KEY'

# Second page (items 11-20)
curl --request GET \
  --url 'https://api.connecteam.com/users/v1/users?limit=10&offset=10' \
  --header 'X-API-KEY: YOUR_API_KEY'

Iterating Through All Results

Continue incrementing offset by limit until the response returns fewer items than the limit, indicating you've reached the end.

offset = 0
limit = 100
all_users = []

while True:
    response = get_users(limit=limit, offset=offset)
    users = response['data']['users']
    all_users.extend(users)
    
    if len(users) < limit:
        break
    offset += limit

API Reference