developers.services.yonomi.cloud Open in urlscan Pro
18.235.25.34  Public Scan

Form analysis
0 forms found in the DOM

Text Content

api organizations

 * API: Organizations
 * Query
   * getInstall
   * getIntegrationAut...
   * getOrganization
   * listInstalls
   * listIntegrationAu...
   * listOrganizations
   * listPublicIntegra...
   * listUserRoles
 * Mutation
   * createInstall
   * createOrganization
   * deleteInstall
   * deleteOrganization
   * grantIntegrationA...
   * grantUserRole
   * removeIntegration...
   * revokeUserRole
   * updateInstall
   * updateOrganization
   * updateUserRole
 * Subscription
 * Objects
   * AppClientConnection
   * AppClientEdge
   * ClientCreds
   * CreateInstallatio...
   * DevGroup
   * FederationConfig
   * FederationConfigC...
   * FederationConfigEdge
   * Install
   * Installation
   * installationClient
   * InstallationEdge
   * InstallationsConn...
   * InstallAttrs
   * InstallConnection
   * InstallEdge
   * Integration
   * IntegrationConnec...
   * IntegrationEdge
   * IntegrationOrgAssoc
   * IntegrationOrgAss...
   * IntegrationOrgAss...
   * ListInstallations...
   * M2MCreds
   * M2MCredsIntegrati...
   * M2MCredsIntegrati...
   * M2MCredsIntegrati...
   * Org
   * OrgAttrs
   * OrgConnection
   * OrgEdge
   * PageInfo
   * PaginationParams
   * PublicIntegration
   * PublicIntegration...
   * PublicIntegration...
   * RequestStatus
   * UserDevGroupAssoc
   * UserDevGroupAssoc...
   * UserDevGroupAssoc...
   * UserOrgAssoc
   * UserOrgAssocAttrs
   * UserOrgAssocConne...
   * UserOrgAssocEdge
   * UserOrgAssocUpdate
   * WebhookConfig
   * WebhookConfigInte...
   * WebhookConfigInte...
   * WebhookConfigInte...
   * WebhookConfigConn...
   * WebhookConfigEdge
 * Scalars
   * AWSDateTime
   * Boolean
   * Float
   * ID
   * Int
   * String
 * Directives
 * Enums
   * AppClientFilter
   * AppTypes
   * ConnectionType
   * DevRoleName
   * RequestStatuses
   * RoleName
   * WebhookEventType
   * WebhookStatus
   * OwnerRoleName
 * Unions
   * AppClient
 * API Reference



Search

Getting StartedAPI: TraitsMobile SDKChangelog


API: Traits
Mobile SDK
Changelog

Dark mode





API: ORGANIZATIONS

Base URL



Production

http://example.io


LANGUAGE BOX

CURL

RUBY

PYTHON

PHP

JAVA

NODE.JS

GO

.NET

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


QUERY

The Query type in GraphQL represents the entry point for retrieving data from
the API. It defines the available read-only operations (queries) that clients
can execute to fetch data.







Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


GETINSTALL

Get installation details.







































HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERS

installIdid Required


RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

getInstallobject

Get installation detailssssss.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 query getInstall($installId: ID!) {
getInstall(installId: $installId) { installationId organization { } name
createdAt updatedAt } }

RESPONSE

200

{
  "getInstall": {
    "installationId": "1234",
    "organization": {},
    "name": null,
    "createdAt": null,
    "updatedAt": null
  }
}

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


GETINTEGRATIONAUTHZTOORG

Get details of an integration's permissions to manage the installations under an
organization.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERS

integrationIdid Required

orgIdid Required


RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

getIntegrationAuthzToOrgobject

Get details of an integration's permissions to manage the installations under an
organization.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
31 32 33 34 35 36 37 38 39 40 41 42 43 44 query
getIntegrationAuthzToOrg($integrationId: ID!, $orgId: ID!) {
getIntegrationAuthzToOrg(integrationId: $integrationId, orgId: $orgId) {
integrationId orgId createdAt updatedAt integration { integrationId name
description isPublic createdAt updatedAt } organization { orgId name createdAt
updatedAt userRoles { edges { } pageInfo { hasNextPage hasPreviousPage
startCursor endCursor } } installations { edges { } pageInfo { hasNextPage
hasPreviousPage startCursor endCursor } } } } }

RESPONSE

200

{
  "getIntegrationAuthzToOrg": {
    "integrationId": null,
    "orgId": null,
    "createdAt": null,
    "updatedAt": null,
    "integration": {
      "integrationId": null,
      "name": null,
      "description": null,
      "isPublic": false,
      "createdAt": null,
      "updatedAt": null
    },
    "organization": {
      "orgId": null,
      "name": null,
      "createdAt": null,
      "updatedAt": null,
      "userRoles": {
        "edges": {
          "cursor": null,
          "node": {
            "userId": null,
            "roleName": null,
            "createdAt": null,
            "updatedAt": null,
            "orgId": null,
            "organization": {}
          }
        },
        "pageInfo": {
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": null,
          "endCursor": null
        }
      },
      "installations": {
        "edges": {
          "cursor": null,
          "node": {
            "installationId": null,
            "organization": {},
            "name": null,
            "createdAt": null,
            "updatedAt": null
          }
        },
        "pageInfo": {
          "hasNextPage": false,
          "hasPreviousPage": false,
          "startCursor": null,
          "endCursor": null
        }
      }
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


GETORGANIZATION

Get organization details.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERS

orgIdid Required


RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

getOrganizationobject

Get organization details.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
query getOrganization($orgId: ID!) { getOrganization(orgId: $orgId) { orgId name
createdAt updatedAt userRoles { edges { } pageInfo { hasNextPage hasPreviousPage
startCursor endCursor } } installations { edges { } pageInfo { hasNextPage
hasPreviousPage startCursor endCursor } } } }

RESPONSE

200

{
  "getOrganization": {
    "orgId": null,
    "name": null,
    "createdAt": null,
    "updatedAt": null,
    "userRoles": {
      "edges": {
        "cursor": null,
        "node": {
          "userId": null,
          "roleName": null,
          "createdAt": null,
          "updatedAt": null,
          "orgId": null,
          "organization": {}
        }
      },
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false,
        "startCursor": null,
        "endCursor": null
      }
    },
    "installations": {
      "edges": {
        "cursor": null,
        "node": {
          "installationId": null,
          "organization": {},
          "name": null,
          "createdAt": null,
          "updatedAt": null
        }
      },
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false,
        "startCursor": null,
        "endCursor": null
      }
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


LISTINSTALLS

List installations.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERSEXPAND ALL

orgIdid Required

paginationParamsobject

child attributes

RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

listInstallsobject Required

List installations.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 query listInstalls($orgId: ID!, $paginationParams:
PaginationParams) { listInstalls(orgId: $orgId, paginationParams:
$paginationParams) { edges { } pageInfo { hasNextPage hasPreviousPage
startCursor endCursor } } }

RESPONSE

200

{
  "listInstalls": {
    "edges": {
      "cursor": null,
      "node": {
        "installationId": null,
        "organization": {},
        "name": null,
        "createdAt": null,
        "updatedAt": null
      }
    },
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


LISTINTEGRATIONAUTHZTOORG

List integrations with permissions to manage the installations under an
organization.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERSEXPAND ALL

orgIdid Required

paginationParamsobject

child attributes

RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

listIntegrationAuthzToOrgobject Required

List integrations with permissions to manage the installations under an
organization.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 query listIntegrationAuthzToOrg($orgId: ID!,
$paginationParams: PaginationParams) { listIntegrationAuthzToOrg(orgId: $orgId,
paginationParams: $paginationParams) { edges { } pageInfo { hasNextPage
hasPreviousPage startCursor endCursor } } }

RESPONSE

200

{
  "listIntegrationAuthzToOrg": {
    "edges": {
      "cursor": null,
      "node": {
        "integrationId": null,
        "orgId": null,
        "createdAt": null,
        "updatedAt": null,
        "integration": {
          "integrationId": null,
          "name": null,
          "description": null,
          "isPublic": false,
          "createdAt": null,
          "updatedAt": null
        },
        "organization": {
          "orgId": null,
          "name": null,
          "createdAt": null,
          "updatedAt": null,
          "userRoles": {
            "edges": {
              "cursor": null,
              "node": {
                "userId": null,
                "roleName": null,
                "createdAt": null,
                "updatedAt": null,
                "orgId": null,
                "organization": {}
              }
            },
            "pageInfo": {
              "hasNextPage": false,
              "hasPreviousPage": false,
              "startCursor": null,
              "endCursor": null
            }
          },
          "installations": {
            "edges": {
              "cursor": null,
              "node": {
                "installationId": null,
                "organization": {},
                "name": null,
                "createdAt": null,
                "updatedAt": null
              }
            },
            "pageInfo": {
              "hasNextPage": false,
              "hasPreviousPage": false,
              "startCursor": null,
              "endCursor": null
            }
          }
        }
      }
    },
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


LISTORGANIZATIONS

List organizations.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERSEXPAND ALL

paginationParamsobject

child attributes

RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

listOrganizationsobject Required

List organizations.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 query listOrganizations($paginationParams:
PaginationParams) { listOrganizations(paginationParams: $paginationParams) {
edges { } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } }

RESPONSE

200

{
  "listOrganizations": {
    "edges": {
      "cursor": null,
      "node": {
        "orgId": null,
        "name": null,
        "createdAt": null,
        "updatedAt": null,
        "userRoles": {
          "edges": {
            "cursor": null,
            "node": {
              "userId": null,
              "roleName": null,
              "createdAt": null,
              "updatedAt": null,
              "orgId": null,
              "organization": {}
            }
          },
          "pageInfo": {
            "hasNextPage": false,
            "hasPreviousPage": false,
            "startCursor": null,
            "endCursor": null
          }
        },
        "installations": {
          "edges": {
            "cursor": null,
            "node": {
              "installationId": null,
              "organization": {},
              "name": null,
              "createdAt": null,
              "updatedAt": null
            }
          },
          "pageInfo": {
            "hasNextPage": false,
            "hasPreviousPage": false,
            "startCursor": null,
            "endCursor": null
          }
        }
      }
    },
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


LISTPUBLICINTEGRATIONS

Get a list of available integrations that manage installations under an
organization.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERSEXPAND ALL

paginationParamsobject

child attributes

RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

listPublicIntegrationsobject Required

Get a list of available integrations that manage installations under an
organization.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 query listPublicIntegrations($paginationParams:
PaginationParams) { listPublicIntegrations(paginationParams: $paginationParams)
{ edges { } pageInfo { hasNextPage hasPreviousPage startCursor endCursor } } }

RESPONSE

200

{
  "listPublicIntegrations": {
    "edges": {
      "cursor": null,
      "node": {
        "integrationId": null,
        "name": null,
        "description": null,
        "isPublic": false,
        "createdAt": null,
        "updatedAt": null
      }
    },
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


LISTUSERROLES

List users with access to an organization.









HEADER PARAMETERSEXPAND ALL


Authorizationstring Required

Specifies the authentication token for the request. The token must be prefixed
with 'Bearer ' followed by the actual token string. This header is required to
authenticate and authorize the request.



BODY PARAMETERSEXPAND ALL

orgIdid Required

paginationParamsobject

child attributes

RESPONSESEXPAND ALL

200
Object


RESPONSE ATTRIBUTES

listUserRolesobject Required

List users with access to an organization.


child attributes
POST
Open menu

Route name

GQL
Open menu

1 2 3 4 5 6 7 8 9 10 11 12 13 query listUserRoles($orgId: ID!,
$paginationParams: PaginationParams) { listUserRoles(orgId: $orgId,
paginationParams: $paginationParams) { edges { } pageInfo { hasNextPage
hasPreviousPage startCursor endCursor } } }

RESPONSE

200

{
  "listUserRoles": {
    "edges": {
      "cursor": null,
      "node": {
        "userId": null,
        "roleName": null,
        "createdAt": null,
        "updatedAt": null,
        "orgId": null,
        "organization": {}
      }
    },
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": null,
      "endCursor": null
    }
  }
}

Show more
Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


MUTATION

The Mutation type in GraphQL is used for modifying or creating data. It defines
the operations (mutations) that allow clients to make changes to the data stored
on the serv

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit

Show more


SUBSCRIPTION

The Subscription type in GraphQL enables real-time communication between clients
and the server. It defines a set of events or data streams that clients can
subscribe to and receive updates whenever the subscribed events occur.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


OBJECTS

Objects in GraphQL represent complex data structures. They define the fields and
their types that can be queried in a GraphQL API. Objects can have nested fields
and relationships with other objects.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit

Show more


SCALARS

Scalars: Scalars in GraphQL represent primitive data types, such as String, Int,
Boolean, Float, etc. They are used to define the types of individual fields in
the GraphQL schema.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit

Show more


DIRECTIVES

Directives in GraphQL provide a way to control the execution behavior of queries
and mutations. They allow you to modify the result, change the execution order,
skip or include fields conditionally, and apply custom logic to the resolution
process.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit


ENUMS

Enums in GraphQL define a set of possible values for a field. They represent a
discrete set of options or states that a field can have. Enums help ensure type
safety and provide a clear list of valid values for a field.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit

Show more


UNIONS

Unions in GraphQL allow you to combine multiple object types into a single type.
They represent a result that can be one of several object types. Unions are
useful when a field can return different types of objects, and you want to
specify all the possible types in the schema.

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit

Show more


API REFERENCE

Base URL



Production

http://example.io


LANGUAGE BOX

CURL

RUBY

PYTHON

PHP

JAVA

NODE.JS

GO

.NET

Was this section helpful?Yes

No


PLEASE LEAVE A COMMENT

CancelSubmit