Skip to main content

List SMS Providers

POST 
https://$CUSTOM-DOMAIN/admin/v1/sms/_search

Returns a list of configured SMS providers.

Request​

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

Responses​

A successful response.

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result

    object[]

  • Array [

    • details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    id string
    state string

    Possible values: [SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED, SMS_PROVIDER_CONFIG_ACTIVE, SMS_PROVIDER_CONFIG_INACTIVE]

    Default value: SMS_PROVIDER_CONFIG_STATE_UNSPECIFIED

    description string

    twilio

    object

    sid string
    senderNumber string
    verifyServiceSid string

    http

    object

    endpoint string

  • ]

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/sms/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  }
}
ResponseClear

Click the Send API Request button above and see the response here!