Customers API

Using the Customers API

API Description can be found in our Swagger docs here: https://app.swaggerhub.com/apis/ProdCamp/prodcamp_app/v1.0#/Customers/post_api_v1_Customers_accounts

GEThttps://app.prodcamp.com/api/v1/Customers/accounts

Query parameters

Response

200

Success

Body

application/json

itemsnullable array of TenantAccountDTO (object)

pagesCountinteger (int32)

pageSizeinteger (int32)

currentPageinteger (int32)

totalItemsCountinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "accountName": "text",
      "companyName": "text",
      "status": {
        "caption": "text"
      },
      "domains": [
        "text"
      ],
      "data": {
        "website": "text",
        "phone": "text",
        "annualRevenue": 0,
        "lifetimeValue": 0,
        "description": "text",
        "industry": "text",
        "type": "text",
        "subscription": "text",
        "accountLevel": "text",
        "signupDate": "2024-11-21T06:24:04.353Z",
        "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
        "timezone": "text"
      },
      "lastEditDate": "2024-11-21T06:24:04.353Z",
      "createdDate": "2024-11-21T06:24:04.353Z"
    }
  ]
}

POSThttps://app.prodcamp.com/api/v1/Customers/accounts

Body

application/json

accountNamenullable string

domainsnullable array of string

dataTenantAccountDataDTO (object)

Response

200400

Success

Body

application/json

contactsnullable array of TenantContactDTO (object)

idinteger (int32)

accountName*string

companyNamenullable string

statusTenantAccountStatus (object)

domainsnullable array of string

dataTenantAccountDataDTO (object)

lastEditDatestring (date-time)

createdDatestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "contacts": [
    {
      "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": {
        "accountName": "text",
        "companyName": "text",
        "status": {
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "website": "text",
          "phone": "text",
          "annualRevenue": 0,
          "lifetimeValue": 0,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2024-11-21T06:24:04.353Z",
          "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
          "timezone": "text"
        },
        "lastEditDate": "2024-11-21T06:24:04.353Z",
        "createdDate": "2024-11-21T06:24:04.353Z"
      }
    }
  ],
  "accountName": "text",
  "companyName": "text",
  "status": {
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "website": "text",
    "phone": "text",
    "annualRevenue": 0,
    "lifetimeValue": 0,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2024-11-21T06:24:04.353Z",
    "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
    "timezone": "text"
  },
  "lastEditDate": "2024-11-21T06:24:04.353Z",
  "createdDate": "2024-11-21T06:24:04.353Z"
}

GEThttps://app.prodcamp.com/api/v1/Customers/accounts/{id}

Path parameters

id*integer (int32)

Response

200

Success

Body

application/json

contactsnullable array of TenantContactDTO (object)

idinteger (int32)

accountName*string

companyNamenullable string

statusTenantAccountStatus (object)

domainsnullable array of string

dataTenantAccountDataDTO (object)

lastEditDatestring (date-time)

createdDatestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/accounts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "contacts": [
    {
      "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": {
        "accountName": "text",
        "companyName": "text",
        "status": {
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "website": "text",
          "phone": "text",
          "annualRevenue": 0,
          "lifetimeValue": 0,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2024-11-21T06:24:04.353Z",
          "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
          "timezone": "text"
        },
        "lastEditDate": "2024-11-21T06:24:04.353Z",
        "createdDate": "2024-11-21T06:24:04.353Z"
      }
    }
  ],
  "accountName": "text",
  "companyName": "text",
  "status": {
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "website": "text",
    "phone": "text",
    "annualRevenue": 0,
    "lifetimeValue": 0,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2024-11-21T06:24:04.353Z",
    "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
    "timezone": "text"
  },
  "lastEditDate": "2024-11-21T06:24:04.353Z",
  "createdDate": "2024-11-21T06:24:04.353Z"
}

PUThttps://app.prodcamp.com/api/v1/Customers/accounts/{id}

Path parameters

id*integer (int32)

Body

application/json

contactsnullable array of TenantContactDTO (object)

idinteger (int32)

accountName*string

companyNamenullable string

statusTenantAccountStatus (object)

domainsnullable array of string

dataTenantAccountDataDTO (object)

lastEditDatestring (date-time)

createdDatestring (date-time)

Response

200

Success

Body

application/json

contactsnullable array of TenantContactDTO (object)

idinteger (int32)

accountName*string

companyNamenullable string

statusTenantAccountStatus (object)

domainsnullable array of string

dataTenantAccountDataDTO (object)

lastEditDatestring (date-time)

createdDatestring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/accounts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "accountName": "text"
    }),
});
const data = await response.json();

Response

200

{
  "contacts": [
    {
      "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": {
        "accountName": "text",
        "companyName": "text",
        "status": {
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "website": "text",
          "phone": "text",
          "annualRevenue": 0,
          "lifetimeValue": 0,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2024-11-21T06:24:04.353Z",
          "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
          "timezone": "text"
        },
        "lastEditDate": "2024-11-21T06:24:04.353Z",
        "createdDate": "2024-11-21T06:24:04.353Z"
      }
    }
  ],
  "accountName": "text",
  "companyName": "text",
  "status": {
    "caption": "text"
  },
  "domains": [
    "text"
  ],
  "data": {
    "website": "text",
    "phone": "text",
    "annualRevenue": 0,
    "lifetimeValue": 0,
    "description": "text",
    "industry": "text",
    "type": "text",
    "subscription": "text",
    "accountLevel": "text",
    "signupDate": "2024-11-21T06:24:04.353Z",
    "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
    "timezone": "text"
  },
  "lastEditDate": "2024-11-21T06:24:04.353Z",
  "createdDate": "2024-11-21T06:24:04.353Z"
}

DELETEhttps://app.prodcamp.com/api/v1/Customers/accounts/{id}

Path parameters

id*integer (int32)

Response

200400404default

Success

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/accounts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404default

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

GEThttps://app.prodcamp.com/api/v1/Customers/contacts

Query parameters

Response

200

Success

Body

application/json

itemsnullable array of TenantContactDTO (object)

pagesCountinteger (int32)

pageSizeinteger (int32)

currentPageinteger (int32)

totalItemsCountinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/contacts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "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": {
        "accountName": "text",
        "companyName": "text",
        "status": {
          "caption": "text"
        },
        "domains": [
          "text"
        ],
        "data": {
          "website": "text",
          "phone": "text",
          "annualRevenue": 0,
          "lifetimeValue": 0,
          "description": "text",
          "industry": "text",
          "type": "text",
          "subscription": "text",
          "accountLevel": "text",
          "signupDate": "2024-11-21T06:24:04.353Z",
          "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
          "timezone": "text"
        },
        "lastEditDate": "2024-11-21T06:24:04.353Z",
        "createdDate": "2024-11-21T06:24:04.353Z"
      }
    }
  ]
}

POSThttps://app.prodcamp.com/api/v1/Customers/contacts

Body

application/json

idinteger (int32)

firstNamenullable string

lastNamenullable string

fullNamenullable string

avatarUrlnullable string

emailnullable string

additionalEmailsnullable array of string

phonenullable string

mobilenullable string

anotherPhonenullable string

titlenullable string

departmentnullable string

companyNamenullable string

accountTenantAccountDTO (object)

accountIdnullable integer (int32)

Response

200

Success

Body

application/json

idinteger (int32)

firstNamenullable string

lastNamenullable string

fullNamenullable string

avatarUrlnullable string

emailnullable string

additionalEmailsnullable array of string

phonenullable string

mobilenullable string

anotherPhonenullable string

titlenullable string

departmentnullable string

companyNamenullable string

accountTenantAccountDTO (object)

accountIdnullable integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/contacts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": {
    "accountName": "text",
    "companyName": "text",
    "status": {
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "website": "text",
      "phone": "text",
      "annualRevenue": 0,
      "lifetimeValue": 0,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2024-11-21T06:24:04.353Z",
      "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
      "timezone": "text"
    },
    "lastEditDate": "2024-11-21T06:24:04.353Z",
    "createdDate": "2024-11-21T06:24:04.353Z"
  }
}

GEThttps://app.prodcamp.com/api/v1/Customers/contacts/{id}

Path parameters

id*integer (int32)

Response

200

Success

Body

application/json

idinteger (int32)

firstNamenullable string

lastNamenullable string

fullNamenullable string

avatarUrlnullable string

emailnullable string

additionalEmailsnullable array of string

phonenullable string

mobilenullable string

anotherPhonenullable string

titlenullable string

departmentnullable string

companyNamenullable string

accountTenantAccountDTO (object)

accountIdnullable integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/contacts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": {
    "accountName": "text",
    "companyName": "text",
    "status": {
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "website": "text",
      "phone": "text",
      "annualRevenue": 0,
      "lifetimeValue": 0,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2024-11-21T06:24:04.353Z",
      "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
      "timezone": "text"
    },
    "lastEditDate": "2024-11-21T06:24:04.353Z",
    "createdDate": "2024-11-21T06:24:04.353Z"
  }
}

PUThttps://app.prodcamp.com/api/v1/Customers/contacts/{id}

Path parameters

id*integer (int32)

Body

application/json

idinteger (int32)

firstNamenullable string

lastNamenullable string

fullNamenullable string

avatarUrlnullable string

emailnullable string

additionalEmailsnullable array of string

phonenullable string

mobilenullable string

anotherPhonenullable string

titlenullable string

departmentnullable string

companyNamenullable string

accountTenantAccountDTO (object)

accountIdnullable integer (int32)

Response

200

Success

Body

application/json

idinteger (int32)

firstNamenullable string

lastNamenullable string

fullNamenullable string

avatarUrlnullable string

emailnullable string

additionalEmailsnullable array of string

phonenullable string

mobilenullable string

anotherPhonenullable string

titlenullable string

departmentnullable string

companyNamenullable string

accountTenantAccountDTO (object)

accountIdnullable integer (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/contacts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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": {
    "accountName": "text",
    "companyName": "text",
    "status": {
      "caption": "text"
    },
    "domains": [
      "text"
    ],
    "data": {
      "website": "text",
      "phone": "text",
      "annualRevenue": 0,
      "lifetimeValue": 0,
      "description": "text",
      "industry": "text",
      "type": "text",
      "subscription": "text",
      "accountLevel": "text",
      "signupDate": "2024-11-21T06:24:04.353Z",
      "firstPurchaseDate": "2024-11-21T06:24:04.353Z",
      "timezone": "text"
    },
    "lastEditDate": "2024-11-21T06:24:04.353Z",
    "createdDate": "2024-11-21T06:24:04.353Z"
  }
}

DELETEhttps://app.prodcamp.com/api/v1/Customers/contacts/{id}

Path parameters

id*integer (int32)

Response

200400404default

Success

Request

JavaScriptCurlPython

const response = await fetch('https://app.prodcamp.com/api/v1/Customers/contacts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400404default

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}