Metadata

Every response contains this block which contains the amount of data being returned and the data still available to be read (if any).

Empty Array Response

When the response to a request is non-existent, please send back an empty array (i.e. "data": []).

API Validation

The API validation in iActs will not accept null values, all mandatory fields must be supplied with a valid value. For ALL optional fields if no value can be provided then the field should be omitted from the API Response.

Accounts

iActs service requesting the client portfolio static data from the host.

POST/accounts

Accounts Batch

Gets a batch of accounts by specifying a set of account IDs in the body of the request.

Parameters

accountIdsArray of Stringsrequired

List of account IDs.

eventIdStringrequired

Event ID.

Attributes

idStringrequired

Unique account ID from host system. Can be the same as portfolio account number if that is a unique account ID.

nameStringrequired

Client account name.

safekeepingAccountStringrequired

Safekeeping account that the portfolio is associated with.

partyIdStringrequired

Agent party identifier.

codeString

Account code, information only field. Can be used to store custody codes which can be both internal or external safekeeping accounts.

aliasString

Client defined account alias.

stakeholdersArray of Objects

List of user stakeholders. Each stakeholder is an object with username (String), fullName (String) and type (String) keys.

Possible values for type: portfolioSpecialist, assistantPortfolioSpecialist, accountingOfficer.

Example:

[
    {
        "username": "jdoe",
        "fullName": "John Doe",
        "type": "accountingOfficer"
    },
    {
        "username": "janesmith",
        "fullName": "Jane Smith",
        "type": "portfolioSpecialist"
    }
]
interestedPartiesArray of Objects

Interested parties, each interested party is an object with partyId (String) and preferredCommType (String) keys.

Possible values for preferredCommType: SWIFT, EMAIL, FAX.

Example:

[{
		"partyId": "BIC12GB2XXX",
		"preferredCommType": "SWIFT"
	},
	{
		"partyId": "BIC12GB3XXX",
		"preferredCommType": "SWIFT"
	}
]
teamsArray of Objects

List of all teams, each team is an object with id (String), name (String) and displayTeams (Boolean) keys. Multiple teams can be associated with an account , all members of the associated teams have data access privileges meaning they can view the client positions. One of the teams provided can be designated as the UI display team which is then presented on the Positions and Voting screens.

Example:

[
    {
        "id": "T5678",
        "name": "Team 5678",
        "displayTeams": true
    },
    {
        "id": "T1234",
        "name": "Team 1234",
        "displayTeams": false
    }
]
taxResidencyString

Tax residency, ISO country code (2 CHARS).

clientDomicileString

Client domicile, ISO country code (2 CHARS).

clientAttributesArray of Objects

Client specific attributes, each attribute is an object with type (String) and value (String) keys.

Possible values for type: managementType, portfolioType, entity, clientResidency, additionalInfo.

Possible values for value according to its type:

  • managementType - One of the following values: Discretionary, Advisory, Custody, No Mandate.

  • portfolioType - One of the following values: TPC (Third Party Custodian), STD (Standard).

  • qib - String value.

  • entity - One of the following values: LON, BNK, GUE, SGP.

  • clientResidency - Client residency, String value e.g. CH, GB, etc.

    • additionalInfo - COMP Value (Mutual Funds). One of the following values: BANK, NOMI, GROS, etc.

Example:

[{
		"type": "entity",
		"value": "LON"
	},
	{
		"type": "portfolioType",
		"value": "TPC"
	}
]
clientEmailsArray of Objects

List of client email addresses, each element of the array is an object with email (String) and language (String). language is an optional element in the API, when it is not provided the system will default to English. When provided, language MUST be in ISO 639-1 format, for example - en: English.

Example:

[
    {
        "email": "example@gmail.com",
        "language": "de"
    },
    {
        "email": "example1@gmail.com",
        "language": "es"
    }
]
POST/accounts
Request:{ "accountIds": ["123DF", "142847", "78532"], "eventId": "VM123" }Response:
{ "metadata": { "resultSet": { "count": 3, "offset": 50, "limit": 25, "total": 3 } }, "data": [ { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "accountingOfficer" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "portfolioSpecialist" } ], "taxResidency": "US", "clientAttributes": [ { "type": "entity", "value": "LON" } ], "name": "Portfolio 1", "safekeepingAccount": "2144200", "partyId": "agent party identifier", "teams": [ { "id": "T1234", "name": "Team 1234", "displayTeams": true } ], "clientDomicile": "CH", "alias": "Alias for account", "id": "123DF", "interestedParties": [ { "partyId": "BIC12GB2XXX", "preferredCommType": "SWIFT" }, { "partyId": "BIC12GB3XXX", "preferredCommType": "SWIFT" } ], "code": "CUSTODYCODE", "clientEmails": [ { "email": "someemail1@email.com", "language": "en" }, { "email": "someemail2@email.com", "language": "de" } ] }, { "stakeholders": [ { "username": "janedoe", "fullName": "Jane Doe", "type": "accountingOfficer" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "portfolioSpecialist" } ], "taxResidency": "US", "clientAttributes": [ { "type": "portfolioType", "value": "TPC" }, { "type": "type2", "value": "value2" } ], "name": "Portfolio 2", "safekeepingAccount": "123144", "partyId": "agent party identifier", "teams": [ { "id": "T5678", "name": "Team 5678", "displayTeams": true } ], "clientDomicile": "CH", "alias": "Alias 2 for account", "id": "142847", "interestedParties": [ { "partyId": "BIC12GB2XXX", "preferredCommType": "SWIFT" } ], "code": "CUSTODYCODE", "clientEmails": [ { "email": "someemail3@email.com", "language": "en" }, { "email": "someemail4@email.com", "language": "es" } ] }, { "stakeholders": [ { "username": "janedoe", "fullName": "Jane Doe", "type": "accountingOfficer" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "portfolioSpecialist" } ], "taxResidency": "US", "clientAttributes": [ { "type": "entity", "value": "BNK" } ], "name": "Portfolio 3", "safekeepingAccount": "1221345", "partyId": "agent party identifier", "teams": [ { "id": "T5678", "name": "Team 5678", "displayTeams": true }, { "id": "T1234", "name": "Team 1234", "displayTeams": false } ], "clientDomicile": "CH", "alias": "Alias 2 for account", "id": "78532", "interestedParties": [ { "partyId": "BIC12GB2XXX", "preferredCommType": "SWIFT" } ], "code": "CUSTODYCODE", "clientEmails": [ { "email": "someemail5@email.com", "language": "en" }, { "email": "someemail6@email.com", "language": "fr" } ] } ] }

Parties

iActs service requesting the parties details from the host systems.

GET/parties
POST/parties
GET/parties/bic/:bic

List All

Gets a list of all parties. Please note that the list of all parties should include the company itself as a party, for it to be considered the primary source, as configured in iActs company's settings.

Attributes

idStringrequired

Party unique identifier.

nameStringrequired

Party name.

typeStringrequired

Party type.

Possible values: VENDOR, CUSTODIAN, INTERNAL-CUSTODIAN, ENTITY, THIRDPARTY.

preferredCommTypeStringrequired

Preferred comm type.

Possible values for preferredCommType: SWIFT, EMAIL, FAX, PORTAL.

addressesArray of Objectsrequired

List of party addresses, each party address is an object address (String) and comType (String) keys. At least one party address is required.

Possible values for comType: SWIFT, EMAIL, FAX, PORTAL. EMAIL, FAX, PORTAL should have a single entry, i.e., the party can have only 1 email address, 1 fax number and 1 portal. However, it can have multiple BIC addresses.

Example:

[{
		"address": "BIC1235PTLXX",
		"comType": "SWIFT"
	},
	{
		"address": "BIC45678PTLXX",
		"comType": "SWIFT"
	},
	{
		"address": "com@client2loans.com",
		"comType": "EMAIL"
	}
]
GET/parties
Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "id": "BIC00GBFXXX", "name": "Client1", "type": "VENDOR", "preferredCommType": "SWIFT", "addresses": [ { "address": "BIC1235GBLXX", "comType": "SWIFT" }, { "address": "com@client1.com", "comType": "EMAIL" } ] }, { "id": "BIC00PTFXXX", "name": "Client2 Loans", "type": "VENDOR", "preferredCommType": "SWIFT", "addresses": [ { "address": "BIC1235PTLXX", "comType": "SWIFT" }, { "address": "BIC45678PTLXX", "comType": "SWIFT" }, { "address": "com@client2loans.com", "comType": "EMAIL" } ] } ] }

Parties Batch

Gets a batch of parties by specifying a set of party IDs in the body of the request.

Parameters

partyIdsArray of Stringsrequired

List of party IDs.

POST/parties
Request:{ "partyIds": ["BIC00GBFXXX", "BIC00PTFXXX"] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "id": "BIC00GBFXXX", "name": "Client1", "type": "VENDOR", "preferredCommType": "SWIFT", "addresses": [ { "address": "BIC1235GBLXX", "comType": "SWIFT" }, { "address": "com@client1.com", "comType": "EMAIL" } ] }, { "id": "BIC00PTFXXX", "name": "Client2 Loans", "type": "VENDOR", "preferredCommType": "SWIFT", "addresses": [ { "address": "BIC1235PTLXX", "comType": "SWIFT" }, { "address": "BIC45678PTLXX", "comType": "SWIFT" }, { "address": "com@client2loans.com", "comType": "EMAIL" } ] } ] }

Party by BIC

Gets a party by BIC.
GET/parties/bic/:bic
Response:
{ "metadata": { "resultSet": { "count": 1, "offset": 50, "limit": 25, "total": 1 } }, "data": [ { "id": "BIC00PTFXXX", "name": "Client2 Loans", "type": "VENDOR", "preferredCommType": "SWIFT", "addresses": [ { "address": "BIC1235PTLXX", "comType": "SWIFT" }, { "address": "BIC45678PTLXX", "comType": "SWIFT" }, { "address": "com@client2loans.com", "comType": "EMAIL" } ] } ] }

Positions

iActs service requesting meeting or corporate action positions from the host.

POST/positions

Positions Batch

Gets a list of positions.

Parameters

filtersArray of Objectsrequired

Filters is an array of objects, each one with type and value (String) keys. Possible values for type: srd (Boolean), meeting-filter (String), meeting-type (String), meeting-classification (String).

asOfEpochrequired

Eligible position date.

typeStringrequired

This parameter informs the receiver of the type of positions being requested, meeting or corporate action. Downstream logic can be different depending of the type of event. Possible values: meeting, corporate-action. When iActs sends out a position request for Meetings it will include three additional parameters that won't exist for Corporate Actions, namely: meeting-filter, meeting-type and meeting-classification (check filters field).

securityIdsArray of Stringsrequired

List of security IDs to be retrieved.

eventIdStringrequired

Event ID.

Attributes

securityIdStringrequired

Parent security ID.

accountIdStringrequired

Portfolio account that holds the position.

balancesArray of Objectsrequired

Set of positions, each position is an object with qualifier (String) - type of position, e.g., traded, settled, eligible, etc - and value (Double) - information only balance to be shown in the UI - keys.

Possible values for qualifier: ELIG, SETT, TRAD, ORFC, ENCU. Note: in Meetings, SETD qualifier is used instead of SETT.

Example:

[{
		"qualifier": "ELIG",
		"value": 1234.00001
	},
	{
		"qualifier": "SETT",
		"value": 432.00001
	},
	{
		"qualifier": "TRAD",
		"value": 563.00001
	}
]
positionDateEpochrequired

Position date.

optInBooleanrequired

Required for meetings only - optional for corporate actions.

placeOfSettlementString

Place of settlement.

POST/positions
Request:{ "securityIds": [ "123AC-002", "123AC-004" ], "type": "meeting", "asOf": 1681396572, "eventId": "VM123", "filters": [ { "type": "meeting-filter", "value": "opt-in" }, { "type": "meeting-type", "value": "GMET" }, { "type": "meeting-classification", "value": "AMET" } ] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [{ "securityId": "123AC-002", "accountId": "142847", "optIn": true, "balances": [{ "qualifier": "ELIG", "value": 1234.00001 }, { "qualifier": "SETT", "value": 432.00001 }, { "qualifier": "TRAD", "value": 563.00001 } ], "placeOfSettlement": "BIC12345XXX", "positionDate": 1675099655000 }, { "securityId": "123AC-004", "accountId": "A6535", "optIn": true, "balances": [{ "qualifier": "ELIG", "value": 1234.00001 }, { "qualifier": "SETT", "value": 432.00001 }, { "qualifier": "TRAD", "value": 563.00001 } ], "placeOfSettlement": "BIC12345XXX", "positionDate": 1675099655000 } ] }

Internal Custodian Positions

iActs service to return the Agent Side eligible positions for Meetings and Corporate Actions . Typically used when the party type is INTERNAL-CUSTODIAN and the Agent Side Eligible positions are not being provided to iActs via MT or MX message.

POST/internal-custodian-positions

Internal Custodian Positions Batch

Gets a list of internal custodian positions.

Parameters

securityIdsArray of Stringsrequired

List of security IDs to be retrieved.

asOfEpochrequired

Eligible position date.

typeStringrequired

This parameter informs the receiver of the type of positions being requested, meeting or corporate action. Downstream logic can be different depending of the type of event. Possible values: meeting, corporate-action. When iActs sends out a position request for Meetings it will include three additional parameters that won't exist for Corporate Actions, namely: meeting-filter, meeting-type and meeting-classification (check filters field).

filtersArray of Objectsrequired

Filters is an array of objects, each one with type and value (String) keys. Possible values for type: srd (Boolean), meeting-filter (String), meeting-type (String), meeting-classification (String).

eventIdStringrequired

Event ID.

Attributes

securityIdStringrequired

Parent security ID.

safekeepingAccountStringrequired

Safekeeping Account

partyIdStringrequired

Agent party ID.

balancesArray of Objectsrequired

Set of positions, each position is an object with qualifier (String) - type of position, e.g., eligible, settled, etc - and value (Double) - information only balance to be shown in the UI - keys.

Possible values for qualifier: ELIG, SETT, TRAD, NOMI, BLOK, PENR, PEND, BORR, SPOS, COLI, COLO, REGO, UNBA, INBA, LOAN. Note: in Meetings, SETD qualifier is used instead of SETT.

Example:

[
   {
      "qualifier": "TRAD",
      "value": 1234.00001
   }
]
POST/internal-custodian-positions
Request:{ "securityIds": [ "123AC-002", "123AC-004" ], "type": "meeting", "asOf": 1681396572, "eventId": "VM123", "filters": [ { "type": "meeting-filter", "value": "opt-in" }, { "type": "meeting-type", "value": "GMET" }, { "type": "meeting-classification", "value": "AMET" } ] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "securityId": "123AC-002", "partyId": "123002", "safekeepingAccount": "401000-1", "balances": [ { "qualifier": "ELIG", "value": 5000.00001 }, { "qualifier": "TRAD", "value": 1234.00001 } ] }, { "securityId": "123AC-004", "partyId": "123004", "safekeepingAccount": "401020-1", "balances": [ { "qualifier": "ELIG", "value": 6000.00001 }, { "qualifier": "TRAD", "value": 4321.00001 } ] } ] }

Securities

iActs service requesting the security master details from the host systems.

POST/securities/alias
POST/securities
GET/securities

List All

Gets a list of all securities.

Attributes

idStringrequired

Unique security identifier.

denominationIntrequired

Nominal value of the instrument, i.e., 1 or 1000. Used to distinguish bonds and equities.

nameStringrequired

Security name, also known as the security short name.

aliasesArray of Objectsrequired

List of market alias type and values. Each market alias is an object with type (String) and alias (String) keys. At least one market alias is required.

Possible values for type: SEDOL, ISIN, CUSIP, VALOR, TICK.

Example:

[
    {
        "type": "ISIN",
        "alias": "US1234567890"
    },
    {
        "type": "CUSIP",
        "alias": "123456789"
    }
]
typeString

Security type is an optional descriptive field that a host can use to bespoke classify their instruments, e.g., Equity, Fixed Income.

subTypeString

Security sub type is an optional descriptive field that a host can use to bespoke classify their instruments, e.g., Warrants, ADR, etc.

currencyString

Currency, ISO currency code (3 CHARS).

countryOfIncString

Country of inc, ISO country code (2 CHARS).

countryOfListingString

Country of listing, ISO country code (2 CHARS).

stakeholdersArray of Objects

List of user stakeholders associated with the security. Each stakeholder is an object with username (String), fullName (String) and type (String) keys.

Possible values for type: trader, analyst, creditOfficer.

Example:

[
    {
        "username": "jdoe",
        "fullName": "John Doe",
        "type": "trader"
    },
    {
        "username": "janesmith",
        "fullName": "Jane Smith",
        "type": "creditOfficer"
    }
]
issuerString

Security issuer.

priceDouble

Security last price.

GET/securities
Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "PT", "name": "Microsoft Corporation", "type": "optional description", "currency": "EUR", "id": "123AC-001", "issuer": "ADE54F67H", "denomination": 1, "aliases": [ { "type": "ISIN", "alias": "US1234567890" }, { "type": "CUSIP", "alias": "123456789" } ], "countryOfListing": "UK", "price": 3.93, "subType": "any optional description" }, { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "PT", "name": "Apple Corporation", "type": "optional description", "currency": "EUR", "id": "123AC-002", "issuer": "ADE54F67H", "denomination": 1, "aliases": [ { "type": "ISIN", "alias": "US1234567890" }, { "type": "CUSIP", "alias": "123456789" } ], "countryOfListing": "UK", "price": 3.93, "subType": "any optional description" } ] }

Securities Batch

Gets a batch of securities by specifying a set of security IDs in the body of the request.
POST/securities
Request:{ "securityIds": [ "123AC-001", "123AC-002" ] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "PT", "name": "Microsoft Corporation", "type": "optional description", "currency": "EUR", "id": "123AC-001", "issuer": "ADE54F67H", "denomination": 1, "aliases": [ { "type": "ISIN", "alias": "US1234567890" }, { "type": "CUSIP", "alias": "123456789" } ], "countryOfListing": "UK", "price": 3.93, "subType": "any optional description" }, { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "PT", "name": "Apple Corporation", "type": "optional description", "currency": "EUR", "id": "123AC-002", "issuer": "ADE54F67H", "denomination": 1, "aliases": [ { "type": "ISIN", "alias": "US1234567890" }, { "type": "CUSIP", "alias": "123456789" } ], "countryOfListing": "UK", "price": 3.93, "subType": "any optional description" } ] }

Security by Alias

Gets securities by their Aliases.

Parameters

securityAliasesArray of Objectsrequired

List of securities aliases to be retrieved. Each alias is an object with `type` (String) and `value` (String) keys. Possible values for `type`: `SEDOL`, `ISIN`, `CUSIP`, `VALOR`, `TICK`.

POST/securities/alias
Request:{ "securityAliases": [ { "type": "ISIN", "value": "US1234567890" }, { "type": "SEDOL", "value": "7393841" } ] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [ { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "PT", "name": "Apple Corporation", "type": "optional description", "currency": "EUR", "id": "123AC-002", "issuer": "ADE54F67H", "denomination": 1, "aliases": [ { "type": "ISIN", "alias": "US1234567890" }, { "type": "CUSIP", "alias": "123456789" } ], "countryOfListing": "UK", "price": 3.93, "subType": "any optional description" }, { "stakeholders": [ { "username": "jdoe", "fullName": "John Doe", "type": "trader" }, { "username": "janesmith", "fullName": "Jane Smith", "type": "creditOfficer" } ], "countryOfInc": "UK", "name": "Apple Corporation 2", "type": "optional description", "currency": "EUR", "id": "123AC-003", "issuer": "ADE76542Y", "denomination": 1, "aliases": [ { "type": "SEDOL", "alias": "7393841" } ], "countryOfListing": "UK", "price": 5.8, "subType": "any optional description" } ] }

Teams

iActs service requesting the users teams details.

GET/teams
POST/teams

List All

Gets all teams.

Attributes

idStringrequired

Unique team identifier.

nameStringrequired

Unique team name.

inboxString

Team e-mail address.

GET/teams
Response:
{ "metadata": { "resultSet": { "count": 3, "offset": 50, "limit": 25, "total": 3 } }, "data": [{ "id": "T1234", "name": "Team US", "inbox": "team@us.com" }, { "id": "T5678", "name": "Team UK", "inbox": "team@uk.com" }, { "id": "T1212", "name": "Team PT", "inbox": "team@pt.com" } ] }

Teams Batch

Gets a batch of teams by specifying a set of team IDs in the body of the request.

Parameters

teamIdsArray of Stringsrequired

List of team IDs.

POST/teams
Request:{ "teamIds": [ "T1234", "T5678" ] }Response:
{ "metadata": { "resultSet": { "count": 2, "offset": 50, "limit": 25, "total": 2 } }, "data": [{ "id": "T1234", "name": "Team US", "inbox": "team@us.com" }, { "id": "T5678", "name": "Team UK", "inbox": "team@uk.com" } ] }

Users

iActs service requesting the users details.

GET/users
POST/users

List All

Gets a list of all users.

Attributes

usernameStringrequired

Unique user identifier, also referred as ID in this documentation.

fullNameStringrequired

User's full name.

emailStringrequired

User's e-mail.

rolesArray of Arraysrequired

List of unique user roles identified by composite keys, combining company ID (String) and role name (String).

Example:

[
	["company1", "role1"],
	["company1", "role2"]
]
teamsArray of Stringsrequired

List of team IDs.

activeBooleanrequired

Flag that indicates whether a user is active or deactivated.

functionsArray of Stringsrequired

List of user functions:

- Admin - Typically system administrations: responsible for add/edit user roles, etc.

- Standard - Back office and front office users.

- Owner - Typically back office users only.

- Panoptic - Gives full visibility of events data.

A user can have multiple functions.

Allowed values: admin, standard, owner, panoptic.

preferredLanguageString

User's preferred language. preferredLanguage is an optional element in the API, when it is not provided the system will default to English. When provided, preferredLanguage MUST be in ISO 639-1 format, for example - en: English.

GET/users
Response:
{ "metadata": { "resultSet": { "count": 4, "offset": 0, "limit": 25, "total": 4 } }, "data": [ { "username": "jdoe", "fullName": "John Doe", "email": "johndoe@test.com", "roles": [ [ "company2", "role1" ], [ "company1", "role2" ] ], "teams": [ "T1234" ], "active": true, "functions": [ "admin" ], "preferredLanguage": "en" }, { "username": "jsmith", "fullName": "John Smith", "email": "jsmith@test.com", "roles": [ [ "company1", "role1" ], [ "company2", "role2" ] ], "teams": [ "T5678" ], "active": true, "functions": [ "standard", "owner" ], "preferredLanguage": "es" }, { "username": "janedoe", "fullName": "Jane Doe", "email": "janedoe@test.com", "roles": [ [ "company1", "role1" ], [ "company1", "role2" ] ], "teams": [ "T1234" ], "active": true, "functions": [ "standard" ], "preferredLanguage": "en" }, { "username": "janesmith", "fullName": "Jane Smith", "email": "janesmith@test.com", "roles": [ [ "company2", "role1" ], [ "company2", "role2" ] ], "teams": [ "T5678" ], "active": false, "functions": [ "standard" ], "preferredLanguage": "en" } ] }

Users Batch

Gets a batch of users by specifying a set of user IDs (also referred as usernames in this documentation) in the body of the request.

Parameters

userIdsArray of Stringsrequired

List of User IDs.

POST/users
Request:{ "userIds": [ "jdoe", "jsmith", "janesmith" ] }Response:
{ "metadata": { "resultSet": { "count": 3, "offset": 0, "limit": 25, "total": 3 } }, "data": [ { "username": "jdoe", "fullName": "John Doe", "email": "johndoe@test.com", "roles": [ [ "company2", "role1" ], [ "company1", "role2" ] ], "teams": [ "T1234" ], "active": true, "functions": [ "admin" ], "preferredLanguage": "en" }, { "username": "jsmith", "fullName": "John Smith", "email": "jsmith@test.com", "roles": [ [ "company1", "role1" ], [ "company2", "role2" ] ], "teams": [ "T5678" ], "active": true, "functions": [ "standard", "owner" ], "preferredLanguage": "es" }, { "username": "janesmith", "fullName": "Jane Smith", "email": "janesmith@test.com", "roles": [ [ "company2", "role1" ], [ "company2", "role2" ] ], "teams": [ "T5678" ], "active": false, "functions": [ "standard" ], "preferredLanguage": "en" } ] }

Copyright © 2023 T-Scape. All Rights Reserved