Skimmer.PublicApi.Host | v1

CustomerActivityLogs

Endpointhttps://publicapi.getskimmer.com

Retrieves all activity logs for a customer.

GET

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs

Retrieves all activity logs for a customer. › path Parameters

customerId

string · required

Retrieves all activity logs for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves all activity logs for a customer. › Responses

object[]

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

GET/Customers/{customerId}/activity-logs

curl --request GET \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerId": "customerId",
    "type": "type",
    "title": "title",
    "description": {},
    "isSystemGenerated": true,
    "relatedEntityId": {},
    "relatedEntityType": {},
    "relatedEntityDisplay": {},
    "secondaryRelatedEntityId": {},
    "secondaryRelatedEntityType": {},
    "secondaryRelatedEntityDisplay": {},
    "createdByName": {},
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedByName": {},
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

plain

Creates a new manual activity log for a customer.

POST

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs

Creates a new manual activity log for a customer. › path Parameters

customerId

string · required

Creates a new manual activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new manual activity log for a customer. › Request Body

Request body for creating a customer activity log.

type

string · enum

Manual customer activity types available through the Public API.

Enum values:

Call

Text

Other

title

string

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

description

string | null

The activity description. Optional, max 300 characters.

authorId

string | null

Optional identifier of the author. Defaults to "System" if not provided.

authorName

string | null

Optional name of the author. Defaults to "System" if not provided.

Creates a new manual activity log for a customer. › Responses

Created

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

POST/Customers/{customerId}/activity-logs

curl --request POST \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "type": "Call",
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}
'

shell

Example Request Body

{
  "type": "Call",
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Retrieves a specific activity log for a customer.

GET

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Retrieves a specific activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Retrieves a specific activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves a specific activity log for a customer. › Responses

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

GET/Customers/{customerId}/activity-logs/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Updates an existing manual activity log for a customer.

PUT

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Updates an existing manual activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Updates an existing manual activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing manual activity log for a customer. › Request Body

Request body for updating a customer activity log.

type

string | null

The activity type (Call, Text, Email, Other).

title

string

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

description

string | null

The activity description. Optional, max 300 characters.

authorId

string | null

Optional identifier of the author. Defaults to "System" if not provided.

authorName

string | null

Optional name of the author. Defaults to "System" if not provided.

Updates an existing manual activity log for a customer. › Responses

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

PUT/Customers/{customerId}/activity-logs/{id}

curl --request PUT \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "type": {},
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}
'

shell

Example Request Body

{
  "type": {},
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Deletes a manually created activity log for a customer.

DELETE

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Deletes a manually created activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Deletes a manually created activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes a manually created activity log for a customer. › Responses

No Content

No data returned

DELETE/Customers/{customerId}/activity-logs/{id}

curl --request DELETE \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

No example specified for this content type

Customers BodiesOfWater

Skimmer.PublicApi.Host | v1

CustomerActivityLogs

Endpointhttps://publicapi.getskimmer.com

Retrieves all activity logs for a customer.

GET

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs

Retrieves all activity logs for a customer. › path Parameters

customerId

string · required

Retrieves all activity logs for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves all activity logs for a customer. › Responses

object[]

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

GET/Customers/{customerId}/activity-logs

curl --request GET \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerId": "customerId",
    "type": "type",
    "title": "title",
    "description": {},
    "isSystemGenerated": true,
    "relatedEntityId": {},
    "relatedEntityType": {},
    "relatedEntityDisplay": {},
    "secondaryRelatedEntityId": {},
    "secondaryRelatedEntityType": {},
    "secondaryRelatedEntityDisplay": {},
    "createdByName": {},
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedByName": {},
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

plain

Creates a new manual activity log for a customer.

POST

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs

Creates a new manual activity log for a customer. › path Parameters

customerId

string · required

Creates a new manual activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Creates a new manual activity log for a customer. › Request Body

Request body for creating a customer activity log.

type

string · enum

Manual customer activity types available through the Public API.

Enum values:

Call

Text

Other

title

string

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

description

string | null

The activity description. Optional, max 300 characters.

authorId

string | null

Optional identifier of the author. Defaults to "System" if not provided.

authorName

string | null

Optional name of the author. Defaults to "System" if not provided.

Creates a new manual activity log for a customer. › Responses

Created

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

POST/Customers/{customerId}/activity-logs

curl --request POST \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "type": "Call",
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}
'

shell

Example Request Body

{
  "type": "Call",
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Retrieves a specific activity log for a customer.

GET

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Retrieves a specific activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Retrieves a specific activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Retrieves a specific activity log for a customer. › Responses

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

GET/Customers/{customerId}/activity-logs/{id}

curl --request GET \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Updates an existing manual activity log for a customer.

PUT

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Updates an existing manual activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Updates an existing manual activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Updates an existing manual activity log for a customer. › Request Body

Request body for updating a customer activity log.

type

string | null

The activity type (Call, Text, Email, Other).

title

string

The activity title. Required, max 60 characters, letters/numbers/dashes/spaces only.

description

string | null

The activity description. Optional, max 300 characters.

authorId

string | null

Optional identifier of the author. Defaults to "System" if not provided.

authorName

string | null

Optional name of the author. Defaults to "System" if not provided.

Updates an existing manual activity log for a customer. › Responses

Represents a customer activity log entry.

customerId

string · required

The customer identifier.

type

string · required

The activity type (e.g. "Call", "Text", "Email", "Other").

title

string · required

The activity title.

id

string · uuid

The unique identifier.

description

string | null

The activity description.

isSystemGenerated

boolean

Whether this activity was system-generated.

relatedEntityId

string | null

The related entity identifier (e.g. InvoiceId, PaymentId).

relatedEntityType

string | null

The related entity type (e.g. "Invoice", "Quote", "Payment", "PaymentMethod", "Job").

relatedEntityDisplay

string | null

Display text for the related entity (e.g. "Invoice #123").

secondaryRelatedEntityId

string | null

The secondary related entity identifier (e.g. JobId, QuoteId).

secondaryRelatedEntityType

string | null

The secondary related entity type.

secondaryRelatedEntityDisplay

string | null

Display text for the secondary related entity (e.g. "Job #123").

createdByName

string | null

The name of the user who created the activity.

createdAt

string · date-time

When the activity was created.

updatedByName

string | null

The name of the user who last updated the activity.

updatedAt

string | null · date-time

When the activity was last updated.

PUT/Customers/{customerId}/activity-logs/{id}

curl --request PUT \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'Content-Type: application/json' \
  --header 'skimmer-api-key: <string>' \
  --data '
{
  "type": {},
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}
'

shell

Example Request Body

{
  "type": {},
  "title": "title",
  "description": {},
  "authorId": {},
  "authorName": {}
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customerId": "customerId",
  "type": "type",
  "title": "title",
  "description": {},
  "isSystemGenerated": true,
  "relatedEntityId": {},
  "relatedEntityType": {},
  "relatedEntityDisplay": {},
  "secondaryRelatedEntityId": {},
  "secondaryRelatedEntityType": {},
  "secondaryRelatedEntityDisplay": {},
  "createdByName": {},
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedByName": {},
  "updatedAt": "2024-08-25T15:00:00Z"
}

plain

Deletes a manually created activity log for a customer.

DELETE

https://publicapi.getskimmer.com

/Customers/{customerId}/activity-logs/{id}

Deletes a manually created activity log for a customer. › path Parameters

customerId

string · required

id

string · uuid · required

Deletes a manually created activity log for a customer. › Headers

skimmer-api-key

string · required

The skimmer-api-key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Deletes a manually created activity log for a customer. › Responses

No Content

No data returned

DELETE/Customers/{customerId}/activity-logs/{id}

curl --request DELETE \
  --url https://publicapi.getskimmer.com/Customers/:customerId/activity-logs/:id \
  --header 'skimmer-api-key: <string>'

shell

Example Responses

No example specified for this content type

Customers BodiesOfWater