{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"id": 1693364594105000000,
"remarkName": "Priority customer",
"nickname": "nickname",
"metaUsername": "alice_01",
"countryCode": "US",
"countryName": "<string>",
"phoneNumber": "+16315551111",
"email": "support@example.com",
"lastSeen": "2022-06-01T12:00:00.000Z",
"lastMessageToPhoneNumber": "+16315551111",
"tags": [
"<string>"
],
"createTime": "2022-06-01T12:00:00.000Z",
"customAttributes": [
{
"name": "<string>",
"value": {}
}
],
"ownerEmail": "support@example.com",
"sourceType": "API",
"sourceId": "batch_import_123",
"sourceUrl": "https://example.com/signup"
}
],
"cursor": {
"after": "1866762588313988096"
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}List contacts
Returns a paginated list of contacts.
Omit pageAfter to use the existing page-based pagination. To use forward cursor pagination, set pageAfter=0 for the first page, then pass the exact cursor.after value returned by the previous response. Cursor results are ordered by contact ID in ascending order.
Do not combine pageAfter with page, pageBefore, offset, or sort. Keep all filters unchanged while following a cursor. Concurrent contact inserts, deletions, or filter-field updates use weak consistency; restart a full traversal with pageAfter=0 when a fresh snapshot is required.
{
"offset": 1,
"limit": 2,
"length": 1,
"total": 1,
"items": [
{
"id": 1693364594105000000,
"remarkName": "Priority customer",
"nickname": "nickname",
"metaUsername": "alice_01",
"countryCode": "US",
"countryName": "<string>",
"phoneNumber": "+16315551111",
"email": "support@example.com",
"lastSeen": "2022-06-01T12:00:00.000Z",
"lastMessageToPhoneNumber": "+16315551111",
"tags": [
"<string>"
],
"createTime": "2022-06-01T12:00:00.000Z",
"customAttributes": [
{
"name": "<string>",
"value": {}
}
],
"ownerEmail": "support@example.com",
"sourceType": "API",
"sourceId": "batch_import_123",
"sourceUrl": "https://example.com/signup"
}
],
"cursor": {
"after": "1866762588313988096"
}
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Query Parameters
Page number of the results to be returned, 1-based.
1 <= x <= 100A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.
1 <= x <= 100Return results inside an object that contains the total result count or not.
Contact ID cursor for forward pagination. Use 0 to start a new cursor traversal. For each subsequent page, pass the exact cursor.after value from the previous response.
The value must be a non-negative decimal integer in the signed 64-bit range (0 through 9223372036854775807). It cannot be combined with page, pageBefore, offset, or sort.
^[0-9]+$"0"
Comma-separated list of tag names. If any tag does not exist, the request fails with a parameter error.
"tag1,tag2"
Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.
"US"
The contact's email address.
"support@example.com"
Response
Successfully retrieved a paginated list of objects.
Represents a given page of contacts. In cursor mode, offset is 0, items are ordered by contact ID in ascending order, and cursor is returned only when another page exists. When includeTotal=true, total is the complete filtered count and is not reduced by the cursor position.
The position of the item this page starts from, zero-based. e.g., the 11th item is at offset 10.
x >= 0A limit on the number of items to be returned, between 1 and 100, defaults to 10.
x >= 1The actual number of items in the page.
x >= 0The total number of items. This field is returned only when the request parameter includeTotal is set to true.
x >= 0An array containing contact objects.
Show child attributes
Show child attributes
Position of the next Contact page. This object is returned only when another page exists.
Show child attributes
Show child attributes