Skip to main content

portalUserByCompany

Returns portal users for the company

portalUserByCompany(
companyId: ID!
page: Int!
limit: Int!
params: PortalUserSearch
): PortalUserCollection

Arguments​

portalUserByCompany.companyId ● ID! non-null scalar​

portalUserByCompany.page ● Int! non-null scalar​

portalUserByCompany.limit ● Int! non-null scalar​

portalUserByCompany.params ● PortalUserSearch input​

Type​

PortalUserCollection object​

PortalUserCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPortalUserByCompany($companyId: ID!, $page: Int!, $limit: Int!) {\n portalUserByCompany(companyId: $companyId, page: $page, limit: $limit) { collection { id name accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","page":1,"limit":1}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute