Retrieve a Number Group Membership

GET 
/number_group_memberships/:id

Retrieves the details of a Number Group Membership that has been previously created. Use the unique ID that was returned from your previous request to identify the specific Number Group Membership.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

id uuidrequired

Unique ID of the number group membership

Responses

200

OK

application/json

Schema

Schema

id uuid

The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.

number_group_id uuid

The unique identifier of the Number Group this membership is associated with.

phone_number

object

A representation of the phone number this membership is associated with.

id uuid

name string

number string

capabilities string[]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "phone_number": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Jenny",
    "number": "+15558675309",
    "capabilities": [
      "voice",
      "sms",
      "mms",
      "fax"
    ]
  }
}

Loading...