Skip to main content

List all credentials

GET 

/telephony_credentials

List all On-demand Credentials.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 50

    The size of the page

    filter[tag] string

    Filter by tag

    filter[name] string

    Filter by name

    filter[status] string

    Filter by status

    filter[resource_id] string

    Filter by resource_id

    filter[sip_username] string

    Filter by sip_username

Responses

200: Successful response with multiple credentials

Schema

    data

    object[]

  • Array [

  • id string

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    name string
    resource_id string

    Identifies the resource this credential is associated with.

    expired boolean

    Defaults to false

    sip_username string

    The randomly generated SIP username for the credential.

    sip_password string

    The randomly generated SIP password for the credential.

    created_at string

    ISO-8601 formatted date indicating when the resource was created.

    updated_at string

    ISO-8601 formatted date indicating when the resource was updated.

    expires_at string

    ISO-8601 formatted date indicating when the resource will expire.

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

400: Bad request

401: Unauthorized

404: Resource not found

Loading...