List All Aliases

Request

This endpoint retrieves a list of all aliases associated with your organization. It supports optional query parameters to filter results by type and paginate through large datasets.

Endpoint:

GET /organization/api/v1/aliases

URL:

https://link.api.datagram.network/organization/api//v1/aliases

Query

Field	Type	Description	Exxample
Type	String	The type of the alias (“live”, “conference”)	"conference"
After	String (Optional)	The cursor parameters	65fd87ea12a9c9b3f1

Example Request

GET /organization/api/v1/aliases HTTP/1.1
Host: link.api.datagram.network
Authorization: <token>

Response

The server returns standard HTTP status codes to indicate the success or failure of the request. Based on the outcome, the response may contain a list of aliases or an error message. Below are the possible responses for this endpoint:

200 OK: Aliases listed successfully.

401 Unauthorized: Unauthorized.

200

Field	Type	Description	Example
After	string (optional)	The cursor parameter used for pagination.	"after page"
entries	list	List of alias entries returned in the response.	(id, type, name, etc.)

Example Response

{
  "after": "after page",
  "entries": [{
      "data": {
        "id": "12345",
        "type": "conference",
        "name": "Alias Name",
        "passcode": null,
        "jwt_secret": null,
        "stream_key": null,
        "expired_at": 1737356308,
        "expired_at": 1737456308
      }
    }
  ]
}

401

Field	Type	Description	Example
error	object	Contains the error details object	UNAUTHORIZED"

Example Response

{
    "error": {
        "message": "UNAUTHORIZED"
    }
}