OBJECT

Query

The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.

link GraphQL Schema definition

  • type Query {
  • # Find a contact by its ID.
  • #
  • # Arguments
  • # id: ID of the object.
  • contact(id: ID!): Contact
  • # Returns a list of the user's contacts.
  • #
  • # Arguments
  • # first: Returns up to the first `n` elements from the list.
  • # after: Returns the elements that come after the specified
  • # cursor.
  • # last: Returns up to the last `n` elements from the list.
  • # before: Returns the elements that come before the specified
  • # cursor.
  • contacts(first: Int, after: String, last: Int, before: String): ContactConnection!
  • # Find contact by its mobile or email.
  • #
  • # Arguments
  • # mobile: Contact's mobile.
  • # email: Contact's email.
  • contactByIdentifier(mobile: Mobile, email: Email): Contact
  • # Find a conversation by its ID.
  • #
  • # Arguments
  • # id: ID of the object.
  • conversation(id: ID!): Conversation
  • # Returns a list of the user's conversations.
  • #
  • # Arguments
  • # first: Returns up to the first `n` elements from the list.
  • # after: Returns the elements that come after the specified
  • # cursor.
  • # last: Returns up to the last `n` elements from the list.
  • # before: Returns the elements that come before the specified
  • # cursor.
  • conversations(first: Int, after: String, last: Int, before: String): ConversationConnection!
  • # Find a message by its ID.
  • #
  • # Arguments
  • # id: ID of the object.
  • message(id: ID!): Message
  • # Returns a user's default form configuration.
  • defaultForm: Form
  • # Returns a user's form configuration.
  • #
  • # Arguments
  • # id: ID of the object.
  • form(id: ID!): Form
  • # Returns a list of the user's forms.
  • forms: [Form!]!
  • # Returns user's information.
  • me: User
  • # Returns a list of the user's configured webhooks.
  • webhooks: [Webhook!]!
  • # Search for available numbers.
  • #
  • # Arguments
  • # startsWith: Digits used for searching available numbers.
  • searchNumbers(startsWith: String): [AvailableNumber!]!
  • }

link Require by

This element is not required by anyone