Skip to main content
GET
/
community
List Communities
curl --request GET \
  --url https://api.dontdie.com/community \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dd-client-id: <api-key>'
[
  {
    "id": "1234-5678-9012-3456",
    "ownerId": "1234-5678-9012-3456",
    "timezone": "America/New_York",
    "communityName": "My Community",
    "conversationId": "1234-5678-9012-3456",
    "city": "New York",
    "isArchived": false,
    "createdAt": "2021-01-01T00:00:00Z",
    "createdBy": "1234-5678-9012-3456",
    "updatedAt": "2021-01-01T00:00:00Z",
    "updatedBy": "1234-5678-9012-3456"
  }
]

Authorizations

​
Authorization
string
header
required

Enter your Bearer token in the format: Bearer

​
x-dd-client-id
string
header
required

Your API client ID for the request

Query Parameters

​
limit
integer
default:10

The number of communities to return

​
offset
integer
default:0

The offset to start the list from

​
query
string

The query to search for

Example:

"london"

Response

200 - application/json

OK

​
id
string
required

The ID of the community

Example:

"1234-5678-9012-3456"

​
ownerId
string
required

The ID of the owner of the community

Example:

"1234-5678-9012-3456"

​
timezone
string
required

The timezone of the community

Example:

"America/New_York"

​
communityName
string
required

The name of the community

Example:

"My Community"

​
conversationId
string
required

The ID of the conversation for the community

Example:

"1234-5678-9012-3456"

​
city
string
required

The city of the community

Example:

"New York"

​
isArchived
boolean
required

Whether the community is archived

Example:

false

​
createdAt
string
required

The date and time the community was created

Example:

"2021-01-01T00:00:00Z"

​
createdBy
string
required

The ID of the user who created the community

Example:

"1234-5678-9012-3456"

​
updatedAt
string
required

The date and time the community was updated

Example:

"2021-01-01T00:00:00Z"

​
updatedBy
string
required

The ID of the user who updated the community

Example:

"1234-5678-9012-3456"