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.
- (: 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.
- (: Int, : String, : Int, : String): ContactConnection!
- # Find contact by its mobile or email.
- #
- # Arguments
- # mobile: Contact's mobile.
- # email: Contact's email.
- (: Mobile, : Email): Contact
- # Find a conversation by its ID.
- #
- # Arguments
- # id: ID of the object.
- (: 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.
- (: Int, : String, : Int, : String): ConversationConnection!
- # Find a message by its ID.
- #
- # Arguments
- # id: ID of the object.
- (: ID!): Message
- # Returns a user's default form configuration.
- : Form
- # Returns a user's form configuration.
- #
- # Arguments
- # id: ID of the object.
- (: ID!): Form
- # Returns a list of the user's forms.
- : [Form!]!
- # Returns user's information.
- : User
- # Returns a list of the user's configured webhooks.
- : [Webhook!]!
- # Search for available numbers.
- #
- # Arguments
- # startsWith: Digits used for searching available numbers.
- (: String): [AvailableNumber!]!
- }
link Require by
This element is not required by anyone