Home
/
Chat
/
Platform API

Organization API

This API allows you to list, view, create and manage your SendBird applications through HTTP requests. Each HTTP request should be authenticated with your organization API key in the request header. The unique API key can be found in your Sendbird Dashboard under Account > Organization settings > General > API key.

HTTP headers

Light Color Skin
Copy
POST /api/v2/applications HTTP/1.1
User-Agent: Mozilla/4.0 (compatible; MSIE5.01; Windows NT)
Host: gate.sendbird.com
Content-Type: application/json;charset=utf-8
Content-Length: length
Accept-Language: en-us
Accept-Encoding: gzip, deflate
Connection: Keep-Alive
SENDBIRDORGANIZATIONAPITOKEN: {organization_api_key}
...


Actions

  • API endpoints in this page are relative to the base URL allocated to your Sendbird application. In this page, the /applications endpoint refers to https://gate.sendbird.com/api/v2/applications.
ActionHTTP request

List applications

GET /applications
Retrieves a list of applications of your organization.

View an application

GET /applications/{app_id}
Retrieves information about an application with a specified application ID.

Create an application

POST /applications
Creates a new application under your organization.

Delete an application

DELETE /applications/{app_id}
Deletes an application with a specified ID.


List applications

Retrieves a list of applications of your organization.

HTTP request

Light Color Skin
Copy
GET https://gate.sendbird.com/api/v2/applications

Parameters

The following table lists the parameters that this action supports.

Optional
Parameter nameTypeDescription

limit

int

Specifies the number of results to retrieve per page. Acceptable values are 1 to 100, inclusive. (Default: 10)

offset

int

Specifies the number of results to skip before retrieving the next page in the result. This is used to mark the starting index of the next page. (Default: 0)

region_key

string

Restricts the search scope by specifying the code of a region to retrieve a list of applications from. Acceptable values are listed in your dashboard under Account > Organization settings > General > API regions.

Query string example
Light Color Skin
Copy
?limit=3&offset=3

Response

If successful, this action returns a list of applications in the response body as shown below.

Status: 200 OK
Light Color Skin
Copy
{
    "count": 40,
    "previous": "https://gate.sendbird.com/api/v2/applications?limit=3&offset=3",
    "next": "https://gate.sendbird.com/api/v2/applications?limit=3&offset=6",
    "results": [
        {
            "app_id": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "app_name": "sendbird_application_staging",
            "api_token": "80af23e7ec3a51fa2792c249aaf9e8f1e5bd4a6c",
            "region": {
                "region_key": "tokyo-1",
                "region_name": "Tokyo, Japan"
            },
            "created_at": "2020-10-13T06:10:59Z"
        },
        ... # More applications
    ]
}

List of response properties

Property nameTypeDescription

count

int

The total count of applications under your organization.

previous

string

The URL to retrieve the previous page in the result set.

next

string

The URL to retrieve the next page in the result set.

results[]

list

A list of applications.


View an application

Retrieves information about an application with a specified application ID.

HTTP request

Light Color Skin
Copy
GET https://gate.sendbird.com/api/v2/applications/{app_id}

Parameters

The following table lists the parameters that this action supports.

Required
Parameter nameTypeDescription

app_id

string

Restricts the search scope for the applications whose name contains the specified parameter value. This search is case-insensitive.

Response

If successful, this action returns an application resource in the response body like the following.

Status: 200 OK
Light Color Skin
Copy
{
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "app_name": "sendbird_application_staging",
    "api_token": "80af23e7ec3a51fa2792c249aaf9e8f1e5bd4a6c",
    "region": {
        "region_key": "tokyo-1",
        "region_name": "Tokyo, Japan"
    },
    "created_at": "2020-10-13T06:10:59Z"
}

Create an application

Creates a new application under your organization.

HTTP request

Light Color Skin
Copy
POST https://gate.sendbird.com/api/v2/applications

Request body

The following table lists the properties of an HTTP request that this action supports.

Properties
RequiredTypeDescription

app_name

string

Specifies the name of an application to create. The name is considered case-insensitive in application search.

region_key

string

Specifies the code of a region in which an application is to be created. Acceptable values are listed in your dashboard under Account > Organization settings > General > API regions.

Request body example
Light Color Skin
Copy
{
    "app_name": "sendbird_application_production",
    "region_key": "tokyo-1"
}

Response

If successful, this action returns an application resource in the response body like the following.

Status: 200 OK
Light Color Skin
Copy
{
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "app_name": "sendbird_application_production",
    "api_token": "b0ar34e7acfa15fa2732c249aaf9e8f1e5bd3ew1",
    "region": {
        "region_key": "tokyo-1",
        "region_name": "Tokyo, Japan"
    },
    "created_at": "2020-10-18T06:10:59Z"
}

Delete an application

Deletes the specified application.

HTTP request

Light Color Skin
Copy
DELETE https://gate.sendbird.com/api/v2/applications/{app_id}

Parameters

The following table lists the parameters that this action supports.

Required
Parameter nameTypeDescription

app_id

string

Specifies a unique ID of the application to turn on push notifications in.

Response

If successful, this action returns an empty body.