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

get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200

Success

application/json
get
/api/v1/Customers/accounts
200

Success

post
Body
accountNamestring | nullableOptional
domainsstring[] | nullableOptional
Responses
200

Success

application/json
post
/api/v1/Customers/accounts
get
Path parameters
idinteger · int32Required
Responses
200

Success

application/json
get
/api/v1/Customers/accounts/{id}
200

Success

put
Path parameters
idinteger · int32Required
Body
idinteger · int32Optional
accountNamestringRequired
companyNamestring | nullableOptional
domainsstring[] | nullableOptional
lastEditDatestring · date-timeOptional
createdDatestring · date-timeOptional
Responses
200

Success

application/json
put
/api/v1/Customers/accounts/{id}
200

Success

delete
Path parameters
idinteger · int32Required
Responses
200

Success

No content

delete
/api/v1/Customers/accounts/{id}

No content

get
Query parameters
PageNumberinteger · int32Optional
PageSizeinteger · int32Optional
OrderBystringOptional
FilterstringOptional
SearchstringOptional
NeedsCountInResponsebooleanOptional
Responses
200

Success

application/json
get
/api/v1/Customers/contacts
200

Success

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
accountIdinteger · int32 | nullableOptional
Responses
200

Success

application/json
post
/api/v1/Customers/contacts
200

Success

get
Path parameters
idinteger · int32Required
Responses
200

Success

application/json
get
/api/v1/Customers/contacts/{id}
200

Success

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
accountIdinteger · int32 | nullableOptional
Responses
200

Success

application/json
put
/api/v1/Customers/contacts/{id}
200

Success

delete
Path parameters
idinteger · int32Required
Responses
200

Success

No content

delete
/api/v1/Customers/contacts/{id}

No content

Last updated

Was this helpful?