Skip to main content

Get Accesses

The allAccesses query returns all Access configurations available in your organization.

An access is the set of credentials and technical settings that lets a Buyer connect to a Seller in HotelX.

Use this endpoint when you need to:

  • Build an internal catalog of usable accesses
  • Validate if an access is active before executing Search/Quote/Book
  • Identify which supplier and credentials are currently configured

Query Overview​

Path: admin/get-accesses/

GraphQL root:

admin {
allAccesses {
edges {
node {
accessData {
...
}
}
}
}
}

The response is a connection, so you can read:

  • edges: list of accesses
  • totalCount: total number of accesses in your organization

Simple Accesses Request​

Use this version when you only need a lightweight inventory of configured accesses.

Returned fields:

  • name
  • isActive
  • code

Advanced Accesses Request​

Use this version when you need integration-level details (credentials, supplier metadata, URLs and runtime parameters).

Returned fields:

  • name
  • isActive
  • code
  • supplier
  • isTest
  • user
  • password (To retrieve this field, ADMIN permissions are required. Otherwise, the value will be null.)
  • urls
  • parameters

Field Descriptions​

The following fields are returned in the accessData object:

FieldDescription
nameThe name of the access configuration.
isActiveIndicates whether the access is currently active.
codeA unique code identifying the access configuration.
supplierThe supplier associated with the access.
isTestSpecifies if the access is for testing purposes.
userThe username used for authentication.
passwordThe password for authentication (requires ADMIN permissions to retrieve).
urlsThe URLs associated with the access configuration.
parametersAdditional runtime parameters for the access configuration.

This table complements the "Returned fields" lists provided earlier by offering detailed descriptions for each field.

Common Use Cases​

  • Validate Access Configurations: Ensure that all access configurations are active and correctly set up.
  • Build Access Catalogs: Create an internal catalog of all available accesses for operational monitoring.
  • Identify Supplier Credentials: Retrieve supplier-specific credentials and information for integration purposes.

Query Example​

Simple Request​

This example retrieves a list of all accesses with their basic details.

query {
admin {
allAccesses {
edges {
node {
name
isActive
code
}
}
}
}
}

Variables Example​

This query does not require variables.

{}

Response Example​

Here is an example of the response:

{
"data": {
"admin": {
"allAccesses": {
"edges": [
{
"node": {
"name": "Access A",
"isActive": true,
"code": "11123"
}
},
{
"node": {
"name": "Access B",
"isActive": false,
"code": "444456"
}
}
]
}
}
}
}

Response Considerations​

  • password requires ADMIN permissions. Without those permissions, it is returned as null.
  • supplier helps you map each access to a specific Seller and context.
  • parameters may vary by Seller integration.