Customers API

PreviousFeatures API

Last updated 1 year ago

Was this helpful?

get

Query parameters

PageNumberinteger · int32optional

PageSizeinteger · int32optional

OrderBystringoptional

Filterstringoptional

Searchstringoptional

NeedsCountInResponsebooleanoptional

Responses

application/json

objectoptional

get

GET /api/v1/Customers/accounts HTTP/1.1
Host: app.prodcamp.com
Accept: */*

200

Success

{
  "items": [
    {
      "id": 1,
      "accountName": "text",
      "companyName": "text",
      "status": {
        "id": 1,
        "caption": "text"
      },
      "domains": [
        "text"
      ],
      "data": {
        "id": 1,
        "website": "text",
        "phone": "text",
        "annualRevenue": 1,
        "lifetimeValue": 1,
        "employeesCount": 1,
        "description": "text",
        "industry": "text",
        "type": "text",
        "subscription": "text",
        "accountLevel": "text",
        "signupDate": "2025-04-17T14:04:58.164Z",
        "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
        "timezone": "text"
      },
      "lastEditDate": "2025-04-17T14:04:58.164Z",
      "createdDate": "2025-04-17T14:04:58.164Z"
    }
  ],
  "pagesCount": 1,
  "pageSize": 1,
  "currentPage": 1,
  "totalItemsCount": 1
}

get

Path parameters

idinteger · int32required

Responses

application/json

objectoptional

get

GET /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

200

Success

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-04-17T14:04:58.164Z",
          "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-04-17T14:04:58.164Z",
        "createdDate": "2025-04-17T14:04:58.164Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-04-17T14:04:58.164Z",
    "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-04-17T14:04:58.164Z",
  "createdDate": "2025-04-17T14:04:58.164Z"
}

delete

Path parameters

idinteger · int32required

Responses

application/json

delete

DELETE /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

No Content

get

Query parameters

PageNumberinteger · int32optional

PageSizeinteger · int32optional

OrderBystringoptional

Filterstringoptional

Searchstringoptional

NeedsCountInResponsebooleanoptional

Responses

application/json

objectoptional

get

GET /api/v1/Customers/contacts HTTP/1.1
Host: app.prodcamp.com
Accept: */*

200

Success

{
  "items": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-04-17T14:04:58.164Z",
          "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-04-17T14:04:58.164Z",
        "createdDate": "2025-04-17T14:04:58.164Z"
      },
      "accountId": 1
    }
  ],
  "pagesCount": 1,
  "pageSize": 1,
  "currentPage": 1,
  "totalItemsCount": 1
}

get

Path parameters

idinteger · int32required

Responses

application/json

objectoptional

get

GET /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-04-17T14:04:58.164Z",
      "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-04-17T14:04:58.164Z",
    "createdDate": "2025-04-17T14:04:58.164Z"
  },
  "accountId": 1
}

delete

Path parameters

idinteger · int32required

Responses

application/json

delete

DELETE /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Accept: */*

No Content

post

Body

accountNamestring | nullableoptional

domainsstring[] | nullableoptional

dataobjectoptional

Responses

application/json

objectoptional

application/json

post

POST /api/v1/Customers/accounts HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "accountName": "text",
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-04-17T14:04:58.164Z",
    "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
    "timezone": "text"
  }
}

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-04-17T14:04:58.164Z",
          "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-04-17T14:04:58.164Z",
        "createdDate": "2025-04-17T14:04:58.164Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-04-17T14:04:58.164Z",
    "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-04-17T14:04:58.164Z",
  "createdDate": "2025-04-17T14:04:58.164Z"
}

put

Path parameters

idinteger · int32required

Body

contactsobject[] | nullableoptional

idinteger · int32optional

accountNamestringrequired

companyNamestring | nullableoptional

statusobjectoptional

domainsstring[] | nullableoptional

dataobjectoptional

lastEditDatestring · date-timeoptional

createdDatestring · date-timeoptional

Responses

application/json

objectoptional

put

PUT /api/v1/Customers/accounts/{id} HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 1257

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-04-17T14:04:58.164Z",
          "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-04-17T14:04:58.164Z",
        "createdDate": "2025-04-17T14:04:58.164Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-04-17T14:04:58.164Z",
    "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-04-17T14:04:58.164Z",
  "createdDate": "2025-04-17T14:04:58.164Z"
}

200

Success

{
  "contacts": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "avatarUrl": "text",
      "email": "text",
      "additionalEmails": [
        "text"
      ],
      "phone": "text",
      "mobile": "text",
      "anotherPhone": "text",
      "title": "text",
      "department": "text",
      "companyName": "text",
      "account": {
        "id": 1,
        "accountName": "text",
        "companyName": "text",
        "status": {
          "id": 1,
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "id": 1,
          "website": "text",
          "phone": "text",
          "annualRevenue": 1,
          "lifetimeValue": 1,
          "employeesCount": 1,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2025-04-17T14:04:58.164Z",
          "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
          "timezone": "text"
        },
        "lastEditDate": "2025-04-17T14:04:58.164Z",
        "createdDate": "2025-04-17T14:04:58.164Z"
      },
      "accountId": 1
    }
  ],
  "id": 1,
  "accountName": "text",
  "companyName": "text",
  "status": {
    "id": 1,
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "id": 1,
    "website": "text",
    "phone": "text",
    "annualRevenue": 1,
    "lifetimeValue": 1,
    "employeesCount": 1,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2025-04-17T14:04:58.164Z",
    "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
    "timezone": "text"
  },
  "lastEditDate": "2025-04-17T14:04:58.164Z",
  "createdDate": "2025-04-17T14:04:58.164Z"
}

post

Body

idinteger · int32optional

firstNamestring | nullableoptional

lastNamestring | nullableoptional

fullNamestring | nullableoptional

avatarUrlstring | nullableoptional

emailstring | nullableoptional

additionalEmailsstring[] | nullableoptional

phonestring | nullableoptional

mobilestring | nullableoptional

anotherPhonestring | nullableoptional

titlestring | nullableoptional

departmentstring | nullableoptional

companyNamestring | nullableoptional

accountobjectoptional

accountIdinteger · int32 | nullableoptional

Responses

application/json

objectoptional

post

POST /api/v1/Customers/contacts HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 751

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-04-17T14:04:58.164Z",
      "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-04-17T14:04:58.164Z",
    "createdDate": "2025-04-17T14:04:58.164Z"
  },
  "accountId": 1
}

200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-04-17T14:04:58.164Z",
      "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-04-17T14:04:58.164Z",
    "createdDate": "2025-04-17T14:04:58.164Z"
  },
  "accountId": 1
}

put

Path parameters

idinteger · int32required

Body

idinteger · int32optional

firstNamestring | nullableoptional

lastNamestring | nullableoptional

fullNamestring | nullableoptional

avatarUrlstring | nullableoptional

emailstring | nullableoptional

additionalEmailsstring[] | nullableoptional

phonestring | nullableoptional

mobilestring | nullableoptional

anotherPhonestring | nullableoptional

titlestring | nullableoptional

departmentstring | nullableoptional

companyNamestring | nullableoptional

accountobjectoptional

accountIdinteger · int32 | nullableoptional

Responses

application/json

objectoptional

put

PUT /api/v1/Customers/contacts/{id} HTTP/1.1
Host: app.prodcamp.com
Content-Type: application/json
Accept: */*
Content-Length: 751

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-04-17T14:04:58.164Z",
      "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-04-17T14:04:58.164Z",
    "createdDate": "2025-04-17T14:04:58.164Z"
  },
  "accountId": 1
}

200

Success

{
  "id": 1,
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "avatarUrl": "text",
  "email": "text",
  "additionalEmails": [
    "text"
  ],
  "phone": "text",
  "mobile": "text",
  "anotherPhone": "text",
  "title": "text",
  "department": "text",
  "companyName": "text",
  "account": {
    "id": 1,
    "accountName": "text",
    "companyName": "text",
    "status": {
      "id": 1,
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "id": 1,
      "website": "text",
      "phone": "text",
      "annualRevenue": 1,
      "lifetimeValue": 1,
      "employeesCount": 1,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2025-04-17T14:04:58.164Z",
      "firstPurchaseDate": "2025-04-17T14:04:58.164Z",
      "timezone": "text"
    },
    "lastEditDate": "2025-04-17T14:04:58.164Z",
    "createdDate": "2025-04-17T14:04:58.164Z"
  },
  "accountId": 1
}

Customers API

Customers API

Using the Customers API

Using the Customers API