Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 2.55 KB

ProcessApi.md

File metadata and controls

71 lines (45 loc) · 2.55 KB

\ProcessApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
GetProcess Get /processes/{processId} Return the informations for a process
GetProcesses Get /processes Return all the processes for your account

GetProcess

GetProcess GetProcess(ctx, processId) Return the informations for a process

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
processId int64 Id of the process

Return type

GetProcess

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProcesses

GetProcesses GetProcesses(ctx, optional) Return all the processes for your account

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetProcessesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetProcessesOpts struct

Name Type Description Notes
limit optional.Int64 Number limitation for the result returned [default to 10]
offset optional.Int64 Beginning point in the list to retrieve from. [default to 0]
sort optional.String Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed [default to desc]

Return type

GetProcesses

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]