get/contactsRead operation

List contacts

Use this operation to list contacts. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.

Required scopes

contacts:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/contacts?cursor=CURSOR&limit=50&archived=false' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/contacts?cursor=CURSOR&limit=50&archived=false', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/contacts?cursor=CURSOR&limit=50&archived=false', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid contacts list \
  --output json

Example response 2xx

{
  "data": [
    "Contact"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": null
    },
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitqueryarchivedquerycategoryquerycompanyIdquerycreatedByIdquerycustomerIdquerygroupIdqueryparentContactIdquerytypequery

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Query parameters

cursor

string

Opaque cursor returned in meta.page.nextCursor.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

archived

boolean

Return archived resources instead of active resources.

category

string

Filter by contact category.

customersupplierteam

companyId

string

Filter people by related company id.

createdById

string

Filter by creator id.

customerId

string

Filter by customer id.

groupId

string

Filter by contact-group id.

parentContactId

string

Filter by parent contact id.

type

string

Filter by contact type.

personcompany

Responses

200A bounded page of resources visible to the credential, with request metadata and an opaque cursor when another page is available.application/json

Response schemaapplication/json

required

array<Contact>

Public API representation of contact.

required

object

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDlistContactsOpenAPI JSON ↗

Documentation feedbackWas this page useful?