Chats
List all chats
List Chats visible to the authenticated Contact.
GET
/
v1
/
chats
List all chats
curl --request GET \
--url https://api.staging.relayapp.im/v1/chats \
--header 'Authorization: Bearer <token>'{
"chats": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"handles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"kind": "user",
"display_name": "<string>",
"image_url": "<string>",
"image_color": "<string>",
"subtitle": "<string>",
"verified": true,
"is_contact": true,
"status": "active",
"left_at": "2023-11-07T05:31:56Z",
"is_me": true,
"owner": {
"kind": "organization",
"name": "<string>",
"verified": true
},
"rive": {
"file": "https://cdn.relayapp.im/rive/0199a000-0000-7000-8000-00000000000b/1790000000000/file-0123456789abcdef.riv",
"artboard": "Call",
"state_machine": "Main",
"view_model": "Main"
},
"timezone": "America/Detroit",
"age_range": "18_plus",
"links": [
"https://github.com/ana",
"https://www.instagram.com/ana"
],
"about": "Builds robots in Ann Arbor.",
"activity_version": "<string>",
"activity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"emoji": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
}
],
"is_group": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"group_chat_icon": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Query Parameters
Maximum number of chats to return per page
Required range:
1 <= x <= 100Pagination cursor from the previous response's next_cursor field.
Omit this parameter for the first page of results.
⌘I
List all chats
curl --request GET \
--url https://api.staging.relayapp.im/v1/chats \
--header 'Authorization: Bearer <token>'{
"chats": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"handles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"handle": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"kind": "user",
"display_name": "<string>",
"image_url": "<string>",
"image_color": "<string>",
"subtitle": "<string>",
"verified": true,
"is_contact": true,
"status": "active",
"left_at": "2023-11-07T05:31:56Z",
"is_me": true,
"owner": {
"kind": "organization",
"name": "<string>",
"verified": true
},
"rive": {
"file": "https://cdn.relayapp.im/rive/0199a000-0000-7000-8000-00000000000b/1790000000000/file-0123456789abcdef.riv",
"artboard": "Call",
"state_machine": "Main",
"view_model": "Main"
},
"timezone": "America/Detroit",
"age_range": "18_plus",
"links": [
"https://github.com/ana",
"https://www.instagram.com/ana"
],
"about": "Builds robots in Ann Arbor.",
"activity_version": "<string>",
"activity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"text": "<string>",
"emoji": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
}
],
"is_group": false,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"group_chat_icon": "<string>"
}
],
"next_cursor": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}
