Customer API (1.0)

Download OpenAPI specification:Download

License: license name

fabric Customer API is a suite of APIs that allow you and your business to manage customer information and customer hierarchy.

The underlying model of fabric Customer is heavily inspired by the ARTS (Association of Retail Technology Standards) Customer Model

There are two categories of APIs that make up fabric Customer. They are categorized as:

  • RESTful (Customer B2C & Customer B2B)
  • Entity Model (Customer Entity & Customer Links)

Customer B2C and Customer B2B are RESTful APIs that will cover the majority of use cases when implementing your customer information integration.

Customer Entity and Customer Links are lower level APIs that offer access to the underlying data model of fabric Customer.

Customer Entity APIs expose the core Entities as APIs with CRUD operations. Should the RESTful constraints get in the way of your implementation, you will be able to orchestrate your own calls to work around the constraints of REST.

Customer Link APIs expose the many-to-many joining tables between each entity that have relations. These APIs are useful for when you want to link existing entities to other existing entities, avoiding duplication of entities that would be observed if just using the RESTful APIs.

The intent of both APIs is to be 100% interoperable with each other. If the RESTful APIs do not provide what you need, you can dive into the Entity Model APIs and orchestrate them together to fulfill your needs.

Notes are added to the RESTful APIs to show how you can perform the same action with the Entity Model APIs

Core Concepts

Party

A party is the core entity that represents a "Customer". A party can represent an organization (party of many) or single person (party of one). You will find that a lot of the API's will reference party or partyId. Consider this the "customer profile".

There are 4 main types for the core entity of party:

  • Organization - "O" - Represents a customer that is an organization used in B2B
  • Household - "H" - Represents a customer that is a collection of people within the same household. Occasionally useful for B2C
  • Person - "P" - Represents a customer that is a single person used in B2C
  • Contact - "C" - Represents a single person that is not necessarily a customer but is a contact of a customer.

Internal Party

Different from party; internal party is for you, the merchant, using fabric to create and store the organization structure within your business (your employees). This is useful for sales agents within your business, should they need to purchase products on behalf of your customers on your storefront. This should not be confused with our Co-Pilot UI users.

Parent Party

Parties have the ability to reference other parties by the way of a parent child relationship. As parties are essentially considered 'customers', this would be an ideal mechanism to use to specify organization customers that have sub organizations that need to be treated as separate customers.

User

A user is defined simply as the login credential to a system (your storefront). Our user model does not store password or authentication method, only username. Users are not considered customers in their own right.

Groups

Groups is an entity in our customer model that allows you to partition Addresses and/or Users that are associated to a party. This would most often be used for when you want to separate users in an organization customer (party), by the department or division they belong to. The key difference between Groups and Sub Organizations (child parties), is that groups are not considered customers.

Individual

An individual represents a customer that is backed by one person.

An individual is a ultimatly a party in the underlying data model, fabric Individual APIs are a convienient way of managing / creating a typical B2C or retail customer.

List Individuals

List Individual Customers

Request
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=2
sortOrder
string

sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "name" "email" "isActive" "partyType"
Example: sortBy=updatedAt
name
string

-Optional. Name of the individual. It can be a partial match.

Example: name=My individual name
traitName
string

-Optional. Filter by trait Name

Example: traitName=Millineal
isActive
boolean

-Optional. Status of the individual.

Enum: false true
Example: isActive=false
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

403

Unauthorized

get/v1/individuals
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Individual

Creates an individual customer

Request
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json

body request

parentPartyId
string

parent party id of the party (Internal fabric ID)

internalPartyId
string

Related internal party id (Internal fabric ID)

name
string

name of the party

partyType
required
string

type of the organization

Value: "P"
isActive
boolean

status of the organization

email
string <email>

It has to be a valid email address.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

Created

400

Invalid party type

post/v1/individuals
Request samples
application/json
{
  • "parentPartyId": "61b121a51d949f0009142ada",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "email@address.com",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "deletedOn": "2021-08-30T23:20:42.822Z",
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Get Individual Customer

Get Individual Customer

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Individual not found

get/v1/individuals/{individualId}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "deletedOn": "2021-08-30T23:20:42.822Z",
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Update Individual

Update Individual Customer

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json

body request

parentPartyId
string

parent party id of the party (Internal fabric ID)

internalPartyId
string

Related internal party id (Internal fabric ID)

name
string

name of the party

partyType
required
string

type of the organization

Value: "P"
isActive
boolean

status of the organization

email
string <email>

It has to be a valid email address.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

Sample response

400

Invalid party type

404

Individual not found

put/v1/individuals/{individualId}
Request samples
application/json
{
  • "parentPartyId": "61b121a51d949f0009142ada",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "email@address.com",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "deletedOn": "2021-08-30T23:20:42.822Z",
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Delete Individual Customer

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Individual not found.

delete/v1/individuals/{individualId}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "INDIVIDUAL P-1",
  • "partyType": "P",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "deletedOn": "2021-08-30T23:20:42.822Z",
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Individual Addresses

APIs to create, update, delete and retreive addresses from an individual

List Individual's Addresses

List addresses from an individual

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=10
sortOrder
string

sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "postalCode" "type" "addressLine1" "country" "city"
Example: sortBy=updatedAt
type
string

-Optional. Type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
Example: type=M
addressLine1
string

-Optional. Address Line 1.

Example: addressLine1=Street 1
city
string

-Optional. City of the address.

Example: city=Boston
country
string

-Optional. Country of the address.

Example: country=Canada
postalCode
string

-Optional. Postal code of the address.

Example: postalCode=0
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

sample response

404

Individual Not Found

get/v1/individuals/{individualId}/addresses
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Individual's Address

Create address for an individual

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
globalAddressId
number

global address id

type
required
string

type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
addressLine1
string

address line 1. If sent it has to contain 1 character or more.

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
string

latitude

longitude
string

longitude

isDefault
boolean

Default Address

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

sample response

400

error when creating the address

404

party not fouund

post/v1/individuals/{individualId}/addresses
Request samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "isDefault": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Get Indivudals Address

Get address for individual

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Individual or Association not found

get/v1/individuals/{individualId}/addresses/{addressId}
Response samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}

Update Individual's Address

Update address for an individual

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
globalAddressId
number

global address id

type
required
string

type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
addressLine1
string

address line 1. If sent it has to contain 1 character or more.

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
string

latitude

longitude
string

longitude

isDefault
boolean

Default Address

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

sample response

400

error when updating the address

404

party not fouund

put/v1/individuals/{individualId}/addresses/{addressId}
Request samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "isDefault": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Delete Individual's Address

Request
path Parameters
individualId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Individual address not found.

delete/v1/individuals/{individualId}/addresses/{addressId}
Response samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}

Organization

APIs to create, update, delete and retreive organizations

List Organizations

Request
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=2
sortOrder
string

sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "name" "email" "isActive" "partyType"
Example: sortBy=updatedAt
id
string

-Optional. Fabric internal id of the record.

Example: id=61bb812bc189460008c998cb
partyType
string

-Optional. Party type.

Enum: "O" "H"
Example: partyType=H
name
string

-Optional. Name of the organization. It can be a partial match.

Example: name=My organization name
traitName
string

-Optional. Filter by trait Name

Example: traitName=Millineal
isActive
boolean

-Optional. Status of the organization.

Enum: false true
Example: isActive=false
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

403

Unauthorized

get/v1/organizations
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Organization

Request
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
parentPartyId
string

parent party id of the party (Internal fabric ID)

internalPartyId
string

Related internal party id (Internal fabric ID)

name
string

name of the party

partyType
required
string

type of the organization

Enum: "H" "O"
isActive
boolean

status of the organization

email
string <email>

It has to be a valid email address.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

OK

400

Organization not created.

post/v1/organizations
Request samples
application/json
{
  • "parentPartyId": "61b121a51d949f0009142ada",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "PARTY P-1",
  • "partyType": "O",
  • "isActive": true,
  • "email": "email@address.com.br",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "MY ORG",
  • "partyType": "O",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Get Organization

Get Organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Organization not found.

get/v1/organizations/{organizationId}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "MY ORG",
  • "partyType": "O",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Update Organization

Update Organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json

body request

parentPartyId
string

parent party id of the party (Internal fabric ID)

internalPartyId
string

Related internal party id (Internal fabric ID)

name
string

name of the party

partyType
required
string

type of the organization

Enum: "H" "O"
isActive
boolean

status of the organization

email
string <email>

It has to be a valid email address.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

Sample response

400

Organization not created.

404

Organization not found.

put/v1/organizations/{organizationId}
Request samples
application/json
{
  • "parentPartyId": "61b121a51d949f0009142ada",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "PARTY P-1",
  • "partyType": "O",
  • "isActive": true,
  • "email": "email@address.com.br",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "MY ORG",
  • "partyType": "O",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Delete Organization

Delete Organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61df41892bf06d00092d0d8f
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Organization not found.

delete/v1/organizations/{organizationId}
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "MY ORG",
  • "partyType": "O",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": true,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Resurrect organization

Resurrect organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Organization not found or not deleted

post/v1/organizations/{organizationId}/resurrect
Response samples
application/json
{
  • "_id": "61df41892bf06d00092d0d8a",
  • "parentPartyId": "61df41892bf06d00092d0d8f",
  • "internalPartyId": "61df41892bf06d00092d0d8c",
  • "name": "MY ORG",
  • "partyType": "O",
  • "isActive": true,
  • "email": "org@gmail.com",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z",
  • "traits": [
    ],
  • "defaultAddress": [
    ]
}

Organization Addresses

APIs to create, update, delete and retreive addresses from an organization

List Organization Addresses

List addresses for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=10
sortOrder
string

sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "postalCode" "type" "addressLine1" "country" "city"
Example: sortBy=updatedAt
type
string

-Optional. Type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
Example: type=M
addressLine1
string

-Optional. Address Line 1.

Example: addressLine1=Street 1
city
string

-Optional. City of the address.

Example: city=Boston
country
string

-Optional. Country of the address.

Example: country=Canada
postalCode
string

-Optional. Postal code of the address.

Example: postalCode=0
isDefault
boolean

-Optional. If default address.

Example: isDefault=false
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

sample response

404

Organization Not Found

get/v1/organizations/{organizationId}/addresses
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Organization Address

Create address for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
globalAddressId
number

global address id

type
required
string

type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
addressLine1
string

address line 1. If sent it has to contain 1 character or more.

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
string

latitude

longitude
string

longitude

isDefault
boolean

Default Address

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

sample response

400

error when creating the address

404

party not fouund

post/v1/organizations/{organizationId}/addresses
Request samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "isDefault": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Get Organization Address

Get Organization Address

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Association not found

get/v1/organizations/{organizationId}/addresses/{addressId}
Response samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}

Update Organization Address

Update address for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
globalAddressId
number

global address id

type
required
string

type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
addressLine1
string

address line 1. If sent it has to contain 1 character or more.

addressLine2
string

address line 2

addressLine3
string

address line 3

addressLine4
string

address line 4

county
string

county

city
string

city

state
string

state

zipCode
number

zipCode

postalCode
string

postalCode

country
string

country

latitude
string

latitude

longitude
string

longitude

isDefault
boolean

Default Address

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

sample response

400

error when creating the address

404

party not fouund

put/v1/organizations/{organizationId}/addresses/{addressId}
Request samples
application/json
{
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "isDefault": false,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "globalAddressId": 1234,
  • "type": "M",
  • "addressLine1": "street 1",
  • "addressLine2": "street 2",
  • "addressLine3": "street 3",
  • "addressLine4": "street 4",
  • "county": "San Diego",
  • "city": "Boston",
  • "state": "Texas",
  • "zipCode": 12345,
  • "postalCode": "ABC-123",
  • "country": "USA",
  • "latitude": 38.8951,
  • "longitude": -77.0364,
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "isDefault": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Delete Organization Address

Delete a address for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
addressId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Association not found

delete/v1/organizations/{organizationId}/addresses/{addressId}
Response samples
application/json
{
  • "message": "Association Removed"
}

Organization Users

APIs to create, update, delete and retreive users from an organization. Organization User represents a junction table to maintain many to many relationships between users and org parties.

List Orgaization's Users

Request
path Parameters
organizationId
required
string
Example: TEST_USER1
query Parameters
offset
required
integer <int32>
Example: offset=0
limit
required
integer <int32>
Example: limit=2
sortOrder
string

sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "username" "firstName" "lastName" "email" "role" "status"
Example: sortBy=updatedAt
username
string

-Optional. To search by username.

Example: username=myRandomUserName
search
string

-Optional. Search string. The search will be done over username, email, firstName or lastName.

Example: search=Alfred
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Organization not found.

get/v1/organizations/{organizationId}/users
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Organization User

Request
path Parameters
organizationId
required
string
Example: TEST_USER1
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
username
required
string non-empty unique

The unique string used to identify a user.

userIdentifier
string

user identifier

title
string

title of the user. If sent it has to contain 1 character or more.

firstName
string

first name of the user. If sent it has to contain 1 character or more.

lastName
string

last name of the user. If sent it has to contain 1 character or more.

email
required
string

email of the user.

primaryPhone
string >= 2 characters

primary phone of the user. If sent it has to contain 2 characters or more.

status
string

status of the user. Default value will be PENDING.

Enum: "ACTIVE" "INACTIVE" "PENDING"
role
string

role of the user

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

OK

400

Organization not found.

post/v1/organizations/{organizationId}/users
Request samples
application/json
{
  • "username": "TEST_USER_5554",
  • "userIdentifier": "user_123",
  • "title": "Mr",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "+1 4534534534",
  • "primaryPhone": "+1 345345345",
  • "status": "ACTIVE",
  • "role": "reporter",
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "username": "TEST_USER_5554",
  • "userIdentifier": "user_123",
  • "title": "Mr",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "+1 4534534534",
  • "primaryPhone": "+1 345345345",
  • "status": "ACTIVE",
  • "role": "reporter",
  • "additionalAttributes": { },
  • "groupId": "61604a30fdfacd0009816e46",
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Get Orgaization User

Get a user for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
userId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Association not found

get/v1/organizations/{organizationId}/users/{userId}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "username": "TEST_USER_5554",
  • "userIdentifier": "user_123",
  • "title": "Mr",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "+1 4534534534",
  • "primaryPhone": "+1 345345345",
  • "status": "ACTIVE",
  • "role": "reporter",
  • "additionalAttributes": { },
  • "groupId": "61604a30fdfacd0009816e46",
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Update Orgaization User

Update Orgaization User

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
userId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json

body request

username
required
string non-empty unique

The unique string used to identify a user.

userIdentifier
string

user identifier

title
string

title of the user. If sent it has to contain 1 character or more.

firstName
string

first name of the user. If sent it has to contain 1 character or more.

lastName
string

last name of the user. If sent it has to contain 1 character or more.

email
required
string

email of the user.

primaryPhone
string >= 2 characters

primary phone of the user. If sent it has to contain 2 characters or more.

status
string

status of the user. Default value will be PENDING.

Enum: "ACTIVE" "INACTIVE" "PENDING"
role
string

role of the user

groupId
string unique

Fabric internal id of the group record.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

Sample response

404

Association not found

put/v1/organizations/{organizationId}/users/{userId}
Request samples
application/json
{
  • "username": "TEST_USER_5554",
  • "userIdentifier": "user_123",
  • "title": "Mr",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "+1 4534534534",
  • "primaryPhone": "+1 345345345",
  • "status": "ACTIVE",
  • "role": "reporter",
  • "groupId": "61604a30fdfacd0009816e46",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "username": "TEST_USER_5554",
  • "userIdentifier": "user_123",
  • "title": "Mr",
  • "firstName": "John",
  • "lastName": "Smith",
  • "email": "+1 4534534534",
  • "primaryPhone": "+1 345345345",
  • "status": "ACTIVE",
  • "role": "reporter",
  • "additionalAttributes": { },
  • "groupId": "61604a30fdfacd0009816e46",
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Delete Orgaization User

Delete user from an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb1
userId
required
string

Fabric internal id of the record

Example: 61a558b1b155125f02be7fb2
header Parameters
x-site-context
required
string (x-site-context)

site context header

Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

Sample response

404

Association not found

delete/v1/organizations/{organizationId}/users/{userId}
Response samples
application/json
{
  • "message": "Association Removed"
}

Organization Groups

APIs to create, update, delete and retreive groups from an organization

List Organization's Groups

List Organization's Groups

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=10
sortOrder
string

-Optional. sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

-Optional. sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "groupType" "email" "name"
Example: sortBy=updatedAt
id
string

-Optional. Fabric internal id of the group record.

Example: id=61dcab7ffb3fbd22e97eb604
search
string

-Optional. Search string. The search will be done over name, email or groupType.

Example: search=group xyz
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Party Not Found

get/v1/organizations/{organizationId}/groups
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Create Organization Group

Create Organization Group

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
userId
string unique

The unique string used to identify a user.

parentUserId
string unique

The unique string used to identify a parent user.

parentPartyId
string unique

The unique string used to identify a parent party.

parentGroupId
string unique

The unique string used to identify a parent group.

groupType
string
Enum: "Department" "Subsidiary" "Business Unit" "Team" "User" "Customer"
name
string

Name of the group.

email
string

email for the group.

primaryPhone
string >= 2 characters

primary phone for the group. If sent it has to contain 2 characters or more.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

OK

404

Party not found.

post/v1/organizations/{organizationId}/groups
Request samples
application/json
{
  • "userId": "619fbb95969ceb49d19cd5a8",
  • "parentUserId": "619fbb95969ceb49d19cd5a8",
  • "parentPartyId": "619fbb95969ceb49d19cd5a8",
  • "parentGroupId": "619fbb95969ceb49d19cd5a8",
  • "groupType": "Department",
  • "name": "Division 01",
  • "email": "email@address.com",
  • "primaryPhone": "+1 345345345",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "parentUserId": "61604a30fdfacd0019816e44",
  • "userId": "61604a30fdfacd0029816e44",
  • "parentPartyId": "61604a30fdfacd0039816e44",
  • "partyId": "61604a30fdfacd0049816e44",
  • "parentGroupId": "61604a30fdfacd0049816e55",
  • "groupType": "Department",
  • "name": "name of the group",
  • "email": "group3@example.com",
  • "primaryPhone": 134343433,
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Get Orgaization Group

Get a group for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
groupId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Party Not Found

get/v1/organizations/{organizationId}/groups/{groupId}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "parentUserId": "61604a30fdfacd0019816e44",
  • "userId": "61604a30fdfacd0029816e44",
  • "parentPartyId": "61604a30fdfacd0039816e44",
  • "partyId": "61604a30fdfacd0049816e44",
  • "parentGroupId": "61604a30fdfacd0049816e55",
  • "groupType": "Department",
  • "name": "name of the group",
  • "email": "group3@example.com",
  • "primaryPhone": 134343433,
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Updates Organization Group

Update Organization Group

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
groupId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Request Body schema: application/json
userId
string unique

The unique string used to identify a user.

parentUserId
string unique

The unique string used to identify a parent user.

parentPartyId
string unique

The unique string used to identify a parent party.

parentGroupId
string unique

The unique string used to identify a parent group.

groupType
string
Enum: "Department" "Subsidiary" "Business Unit" "Team" "User" "Customer"
name
string

Name of the group.

email
string

email for the group.

primaryPhone
string >= 2 characters

primary phone for the group. If sent it has to contain 2 characters or more.

additionalAttributes
object

Contains all additional attributes not captured in the schema.

Responses
200

OK

404

Party not found.

put/v1/organizations/{organizationId}/groups/{groupId}
Request samples
application/json
{
  • "userId": "619fbb95969ceb49d19cd5a8",
  • "parentUserId": "619fbb95969ceb49d19cd5a8",
  • "parentPartyId": "619fbb95969ceb49d19cd5a8",
  • "parentGroupId": "619fbb95969ceb49d19cd5a8",
  • "groupType": "Department",
  • "name": "Division 01",
  • "email": "email@address.com",
  • "primaryPhone": "+1 345345345",
  • "additionalAttributes": { }
}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "parentUserId": "61604a30fdfacd0019816e44",
  • "userId": "61604a30fdfacd0029816e44",
  • "parentPartyId": "61604a30fdfacd0039816e44",
  • "partyId": "61604a30fdfacd0049816e44",
  • "parentGroupId": "61604a30fdfacd0049816e55",
  • "groupType": "Department",
  • "name": "name of the group",
  • "email": "group3@example.com",
  • "primaryPhone": 134343433,
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Delete Orgaization Group

Deletes a group for an organization

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
groupId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Party Not Found

delete/v1/organizations/{organizationId}/groups/{groupId}
Response samples
application/json
{
  • "_id": "61604a30fdfacd0009816e44",
  • "parentUserId": "61604a30fdfacd0019816e44",
  • "userId": "61604a30fdfacd0029816e44",
  • "parentPartyId": "61604a30fdfacd0039816e44",
  • "partyId": "61604a30fdfacd0049816e44",
  • "parentGroupId": "61604a30fdfacd0049816e55",
  • "groupType": "Department",
  • "name": "name of the group",
  • "email": "group3@example.com",
  • "primaryPhone": 134343433,
  • "additionalAttributes": { },
  • "isDeleted": false,
  • "createdAt": "2021-08-30T23:20:42.822Z",
  • "updatedAt": "2021-08-30T23:20:42.822Z"
}

Organization Group Addresses

APIs to retreive addresses from an organization group

List Orgaization Group Addresses

Lists addresses from an organization group

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
groupId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a9
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=10
sortOrder
string

-Optional. sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

-Optional. sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "postalCode" "type" "addressLine1" "country" "city"
Example: sortBy=updatedAt
id
string

-Optional. Fabric internal id of the group record.

Example: id=61dcab7ffb3fbd22e97eb604
type
string

-Optional. Type of the address. M=Mail, E=Email, P=Postal

Enum: "M" "E" "P"
Example: type=M
search
string

-Optional. Search string. The search will be done over addressLine1, country or globalAddressId.

Example: search=group xyz
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Party or Group Not Found

get/v1/organizations/{organizationId}/groups/{groupId}/addresses
Response samples
application/json
{
  • "query": {
    },
  • "data": [
    ]
}

Organization Group Users

APIs to get users from an organization and group

List Organization Group Users

Lists users from an organization group

Request
path Parameters
organizationId
required
string

Fabric internal id of the record.

Example: 619fbb95969ceb49d19cd5a8
groupId
required
string

Fabric internal id of the record.

Example: 61604a30fdfacd0009816e46
query Parameters
offset
integer <int32>

-Optional. Default:0. Number of records you wish to skip before selecting records.

Example: offset=0
limit
integer <int32>

-Optional. Default:10. Limits the number of records returned by the api.

Example: limit=10
sortOrder
string

-Optional. sort directions of the retreived records. Default value desc.

Enum: "asc" "desc"
Example: sortOrder=desc
sortBy
string

-Optional. sort field of the retreived records. Default value updatedAt.

Enum: "updatedAt" "username" "firstName" "lastName" "email"
Example: sortBy=updatedAt
search
string

-Optional. Search string. The search will be done over username, firstName, lastName or email.

Example: search=group xyz
username
string

-Optional. To search by username.

Example: username=myRandomUserName
header Parameters
x-site-context
required
string (x-site-context)
Example: Example:{"date":"2021-08-19T17:42:59.245Z", "channel":12, "account":"60f59f", "stage":"dev02"}
Authorization
required
string

Authentication token

Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Responses
200

OK

404

Party or Group Not Found

get/v1/organizations/{organizationId}/groups/{groupId}/users
Response samples